Set-CsRegistrarConfiguration

Syntax

Set-CsRegistrarConfiguration
   [[-Identity] <XdsIdentity>]
   [-DefaultEndpointExpiration <Int32>]
   [-EnableDHCPServer <Boolean>]
   [-MaxEndpointExpiration <Int32>]
   [-MaxEndpointsPerUser <UInt16>]
   [-MinEndpointExpiration <Int32>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [-BackupStoreUnavailableThreshold <TimeSpan>]
   [-MaxUserCount <UInt64>]
   [-PoolState <PoolState>]
   [-EnableWinFabLogUpload <Boolean>]
   [-UserCertificateReplicationThreshold <UInt64>]
   [-WinFabMaxLogsSizeMb <Int32>]
   [<CommonParameters>]

Set-CsRegistrarConfiguration
   [-Instance <PSObject>]
   [-DefaultEndpointExpiration <Int32>]
   [-EnableDHCPServer <Boolean>]
   [-MaxEndpointExpiration <Int32>]
   [-MaxEndpointsPerUser <UInt16>]
   [-MinEndpointExpiration <Int32>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [-BackupStoreUnavailableThreshold <TimeSpan>]
   [-MaxUserCount <UInt64>]
   [-PoolState <PoolState>]
   [-EnableWinFabLogUpload <Boolean>]
   [-UserCertificateReplicationThreshold <UInt64>]
   [-WinFabMaxLogsSizeMb <Int32>]
   [<CommonParameters>]

Description

The Registrar is perhaps the most important component in Skype for Business Server; after all, 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 sends a REGISTER request to the Registrar; 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.

Registrar configuration settings are used to help manage endpoints and endpoint subscriptions; these settings can be applied at the global, site, or service scope. (Service scoped-settings are only used with the Registrar service.) The Set-CsRegistrarConfiguration cmdlet can be used to modify any (or all) of the Registrar configuration collections currently in use in your organization.

Examples

-------------------------- Example 1 --------------------------

Set-CsRegistrarConfiguration -Identity site:Redmond -EnableDHCPServer $True

Example 1 modifies the Registrar configuration settings applied to the Redmond site (-Identity site:Redmond). In this example, the value of the EnableDHCPServer property is set to True.

-------------------------- Example 2 --------------------------

Get-CsRegistrarConfiguration | Where-Object {$_.MaxEndpointsPerUser -gt 8} | Set-CsRegistrarConfiguration -MaxEndpointsPerUser 8

In Example 2, any Registrar configuration settings that allow users more than 8 endpoints are modified. To accomplish this, the command first calls the Get-CsRegistrarConfiguration cmdlet without any parameters; this returns a collection of all the Registrar configuration settings used in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the MaxEndpointsPerUser property is greater than (-gt) 8. Finally, the filtered collection is piped to the Set-CsRegistrarConfiguration cmdlet, which sets the maximum number of endpoints for each item in that collection to 8.

-------------------------- Example 3 --------------------------

Get-CsRegistrarConfiguration -Filter "site:*"| Set-CsRegistrarConfiguration -EnableDHCPServer $False

The command shown in Example 3 disables client registration via DHCP for each site in the organization that hosts a collection of Registrar configuration settings. To do this, the command calls the Get-CsRegistrarConfiguration cmdlet along with the Filter parameter; the parameter value "site:*" limits the returned data to settings that have been configured at the site scope. This collection is then piped to the Set-CsRegistrarConfiguration cmdlet, which uses the EnableDHCPServer parameter and the parameter value $False to prevent clients from using a DHCP server to locate a Registrar.

Parameters

-BackupStoreUnavailableThreshold

-Confirm

-DefaultEndpointExpiration

-EnableDHCPServer

-EnableWinFabLogUpload

-Force

-Identity

-Instance

-MaxEndpointExpiration

-MaxEndpointsPerUser

-MaxUserCount

-MinEndpointExpiration

-PoolState

-UserCertificateReplicationThreshold

-WhatIf

-WinFabMaxLogsSizeMb

Inputs

Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object. The Set-CsRegistrarConfiguration cmdlet accepts pipelined instances of the Registrar settings object.

Outputs

The Set-CsRegistrarConfiguration cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object.

Related Links

• Get-CsRegistrarConfiguration
• New-CsRegistrarConfiguration
• Remove-CsRegistrarConfiguration