Parameters

The Registrar is perhaps the most important component in Microsoft Lync Server 2010; after all, 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 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.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsRegistrarConfiguration 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-CsRegistrarConfiguration"}

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

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

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

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

The preceding command 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 --------------------------

	Copy Code
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 Get-CsRegistrarConfiguration without any parameters; this returns a collection of all the Registrar configuration settings used in the organization. This collection is then piped to Where-Object, which picks out only those settings where the MaxEndpointsPerUser property is greater than (-gt) 8. Finally, the filtered collection is piped to Set-CsRegistrarCollection, which sets the maximum number of endpoints for each item in that collection to 8.

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

	Copy Code
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 Get-CsRegistrarConfiguration 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 Set-CsRegistrarConfiguration, which uses the EnableDHCPServer parameter and the parameter value $False to prevent clients from using a DHCP server to locate a Registrar.

Other Resources