Set-CsRegistrar
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. This cmdlet was introduced in Lync Server 2010.
Syntax
Default (Default)
Set-CsRegistrar
[[-Identity] <XdsGlobalRelativeIdentity>]
[-ArchivingServer <String>]
[-BackupRegistrar <String>]
[-EdgeServer <String>]
[-EnableAutomaticFailover <Boolean>]
[-FailbackDetectionInterval <TimeSpan>]
[-FailureDetectionInterval <TimeSpan>]
[-MonitoringServer <String>]
[-SipPort <UInt16>]
[-UserServer <String>]
[-WebPort <UInt16>]
[-WebServer <String>]
[-Force]
[-WhatIf]
[-Confirm]
[-Registrar <String>]
[-SipHealthPort <UInt16>]
[-SipServerTcpPort <UInt16>]
[-ArchivingDatabase <String>]
[-LyssWcfMtlsPort <UInt16>]
[-MirrorArchivingDatabase <String>]
[-MirrorMonitoringDatabase <String>]
[-MonitoringDatabase <String>]
[-WinFabClientConnectionPort <UInt16>]
[-WinFabFederationPort <UInt16>]
[-WinFabIPCPort <UInt16>]
[-WinFabLeaseAgentPort <UInt16>]
[-WinFabReplicationPort <UInt16>]
[-XmppGatewaySipPort <UInt16>]
[<CommonParameters>]
Description
The Registrar is perhaps the most important component in Skype for Business Server; without a Registrar, users would not be able to log on to the system and Skype for Business Server would not be able to keep track of users and their current status. When a user logs on to Skype for Business 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.
Examples
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}
Example 2 sets the SIP port for all the Registrars in the organization to 5072.
To do this, the command first uses the Get-CsService cmdlet 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.
Parameters
-ArchivingDatabase
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service Identity of the database used by the Archiving service.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ArchivingServer
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service location of the Archiving Server to be associated with the Registrar. For example:
-ArchivingServer "ArchivingServer:atl-cs-001.litwareinc.com"
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-BackupRegistrar
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service location of the Registrar to be used if this Registrar is not available. For example:
-BackupRegistrar "Registrar:dublin-cs-001.litwareinc.com"
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Prompts you for confirmation before executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EdgeServer
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service location of the Edge Server to be associated with the Registrar. For example:
-EdgeServer "EdgeServer:atl-edge-001.litwareinc.com"
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableAutomaticFailover
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FailbackDetectionInterval
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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, Skype for Business 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.
Parameter properties
| Type: | TimeSpan |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FailureDetectionInterval
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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.
Parameter properties
| Type: | TimeSpan |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Suppresses the display of any non-fatal error message that might occur when running the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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"
Parameter properties
| Type: | XdsGlobalRelativeIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LyssWcfMtlsPort
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Port used by the Lync Storage Service (LYSS). The default value is 5077.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MirrorArchivingDatabase
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service Identity of the mirror database used by the Archiving service.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MirrorMonitoringDatabase
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service Identity of the mirror database used by the Monitoring service.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MonitoringDatabase
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service Identity of the monitoring database associated with the Registrar.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MonitoringServer
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service location of the Monitoring Server to be associated with the Registrar. For example:
-MonitoringServer "MonitoringServer:atl-cs-001.litwareinc.com"
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Registrar
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service location of the Registrar.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SipHealthPort
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Port used for monitoring server health.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SipPort
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Port used for SIP (Session Initiation Protocol) traffic.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SipServerTcpPort
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
SIP listening port. The default value is 5060.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserServer
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service location of the User Services server to be associated with the Registrar. For example:
-UserServer "UserServer:atl-cs-001.litwareinc.com"
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WebPort
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Port used for communicating with Web servers.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WebServer
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Service location of the Web Server to be associated with the Registrar. For example:
-WebServer "WebServer:atl-cs-001.litwareinc.com"
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Describes what would happen if you executed the command without actually executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WinFabClientConnectionPort
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Port used for client connections to Windows Fabric. The default value is 5092.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WinFabFederationPort
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Port used for Windows Fabric federation. Federation refers to the process by which Windows fabric routes messages. The default value is 5090.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WinFabIPCPort
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Port used by Windows Fabric for inter-process communication (IPC). IPC is a technology that allows for multiple threads in a process to exchange data. The default value is 5093.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WinFabLeaseAgentPort
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Port used by the Windows Fabric lease agent. Lease agents are used to interact with the kernel level lease driver. The default value is 5091.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WinFabReplicationPort
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Port used for Windows Fabric replication. Skype for Business Server uses Windows Fabric to replicate conference directories to all the Front End servers within a Registrar pool. The default value is 5094.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-XmppGatewaySipPort
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Port used by the XMPP gateway associated with the Registrar. The extensible Messaging and Presence Protocol (XMPP) is an open-standard communications protocol for exchanging messages using XML. An allowed partner is an IM and presence provider whose users are allowed to exchange instant messages and presence information with your Skype for Business Server users. The default value is 5098.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
The Set-CsRegistrar cmdlet does not accept pipelined input.
Outputs
None
The Set-CsRegistrar cmdlet does not return any objects or values.
Instead, the command modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayRegistrar object.