Get-CsRegistrarConfiguration

Syntax

Get-CsRegistrarConfiguration
   [[-Identity] <XdsIdentity>]
   [-LocalStore]
   [<CommonParameters>]

Get-CsRegistrarConfiguration
   [-Filter <String>]
   [-LocalStore]
   [<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 can only be used with the Registrar service.) The Get-CsRegistrarConfiguration cmdlet is used to return information about all the Registrar configurations collections currently in use in your organization.

Examples

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

Get-CsRegistrarConfiguration

The command shown in Example 1 returns a collection of all the Registrar configuration settings currently in use in the organization.

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

Get-CsRegistrarConfiguration -Identity site:Redmond

Example 2 returns a single collection of Registrar configuration settings: the settings configured for the Redmond site (-Identity site:Redmond).

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

Get-CsRegistrarConfiguration -Filter "service:*"

In Example 3, information is returned for all the Registrar configuration settings assigned at the service scope. To do this, the command uses the Filter parameter and the filter value "service:*"; that filter value ensures that only settings that have an Identity that begins with the string value "service:" will be returned.

-------------------------- Example 4 --------------------------

Get-CsRegistrarConfiguration | Where-Object {$_.EnableDHCPServer -eq $True}

Example 4 returns information about the Registrar configuration settings that enable the use of DHCP servers in order to register clients. To carry out this task, the command first calls the Get-CsRegistrarConfiguration cmdlet without any parameters; that returns a collection of all the Registrar configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which selects only those settings where the EnableDHCPServer property is equal to True.

-------------------------- Example 5 --------------------------

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

In Example 5, information is returned for all the Registrar configuration settings that allow more than eight endpoints per user. To accomplish this, the command first uses the Get-CsRegistrarConfiguration cmdlet to return 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 those settings where the MaxEndpointsPerUser property is greater than 8.

Parameters

-Filter

-Identity

-LocalStore

Inputs

None

Outputs

Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings

Related Links

• New-CsRegistrarConfiguration
• Remove-CsRegistrarConfiguration
• Set-CsRegistrarConfiguration