[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Returns information about the registrar configuration settings currently in use in your organization. Registrars are used any time a user logs onto (or off of) Microsoft Communications Server 2010. The registrar retrieves location information from the user agent (IP address, port, and user name) and then writes this information to the internal database. This information enables Communications Server 2010 to keep track of the status, and whereabouts, of the user.

Syntax


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


Get-CsRegistrarConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]

Parameters

Parameter	Required	Type	Description
Identity	Optional	Xds Identity	Unique identifier for the registrar configuration settings to be returned. To return the global settings, use this syntax: -Identity global. To return settings configured at the site scope, use syntax similar to this: -Identity site:Redmond. To return settings at the service level, use syntax like this: -Identity service:Registrar:atl-cs-001.litwareinc.com. If this parameter is omitted then Get-CsRegistrarConfiguration returns all the registrar configuration settings currently in use in your organization.
Filter	Optional	String	Enables you to use wildcards in order to return one or more collections of registrar configuration settings. For example, to return all the settings configured at the site scope use this syntax: -Filter "site:". To return all the settings configured at the service scope use this syntax: -Filter "service:".
LocalStore	Optional	Switch Parameter

Parameter

Required

Type

Description

Identity

Optional

Xds Identity

Unique identifier for the registrar configuration settings to be returned. To return the global settings, use this syntax: -Identity global. To return settings configured at the site scope, use syntax similar to this: -Identity site:Redmond. To return settings at the service level, use syntax like this: -Identity service:Registrar:atl-cs-001.litwareinc.com.

If this parameter is omitted then Get-CsRegistrarConfiguration returns all the registrar configuration settings currently in use in your organization.

Filter

Optional

String

Enables you to use wildcards in order to return one or more collections of registrar configuration settings. For example, to return all the settings configured at the site scope use this syntax: -Filter "site:*". To return all the settings configured at the service scope use this syntax: -Filter "service:*".

LocalStore

Optional

Switch Parameter

Detailed Description

The Registrar is perhaps the most important component in Communications Server 2010; after all, without a Registrar, users would not be able to log on to the system, and Communications Server 2010 would not be able to keep track of users and their current status. When a user logs on to Communications Server 2010 the endpoint the user is logging on from (be it a computer, a cell 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 logon and logoff, the Registrar keeps status information up-to-date and helps to route messages to and from the user.

The CsRegistrarConfiguration cmdlets are used to help manage endpoints and endpoint subscriptions; the corresponding registrar configuration collections 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.

Return Types

Get-CsRegistrarConfiguration returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Registrar.RegistrarSettings object.

Examples

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

	Copy Code
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 --------------------------

	Copy Code
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 --------------------------

	Copy Code
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 --------------------------

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

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

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

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

In the preceding command, information is returned for all the registrar configuration settings which allow more than 8 endpoints per user. To accomplish this, the command first uses Get-CsRegistrarConfiguration 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 (-gt) 8.