Removes an existing collection of registrar configuration settings. 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 to keep track of the status, and whereabouts, of the user.
Syntax
Remove-CsRegistrarConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Xds Identity |
Unique identifier for the registrar configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: -Identity site:Redmond. To remove settings at the service level, use syntax like this: -Identity service:Registar:atl-cs-001.litwareinc.com. Note that Remove-CsRegistrarConfiguration can also be run against the global settings (-identity global). In that case, however, the global settings will not be removed. Instead, all the properties in the global collection will be reset to their default values. |
|
Force |
Required |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
|
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
|
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Detailed Description
The Registrar is perhaps the most important component in Microsoft Communications Server; after all, without a Registrar users would not be able to log on to the system, and Communications Server would not be able to keep track of users and their current status. When a user logs of to Microsoft Communications Server 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 Remove-CsRegistrarConfiguration cmdlet enables you to remove registrar configuration settings that have been applied at the site or service scope. Note that this does not delete or uninstall any Registrars; it simply removes the configuration settings that govern those Registrars. If these settings do not exist at either the site or the service scope then a Registrar will be managed using the global settings.
Remove-CsRegistrarConfiguration can also be run against the global registrar configuration settings. In that case, however, the settings will not be removed; that’s because the global settings cannot be deleted. Instead, all the properties in that global collection will be reset to their default values. For example, if you have changed the value of the MinEndpointExpiration property to 500 that value will be reset back to 300.
Return Types
Remove-CsRegistrarConfiguration deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Remove-CsRegistrarConfiguration -Identity site:Redmond |
|
The command shown in Example 1 deletes the registrar configuration settings assigned to the Redmond site. When these settings are deleted, registrars in the Redmond site will automatically use the global registrar settings.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Get-CsRegistrarConfiguration -Filter "service:*" | Remove-CsRegistrarConfiguration |
|
The preceding command deletes all the registrar configuration settings that have been assigned to the service scope. To do this, the command first calls Get-CsRegistrarConfiguration along with the -Filter parameter; the filter value "service:*" limits the returned data to settings where the Identity begins with the characters "service:". The filtered collection is then piped to Remove-CsRegistrarConfiguration, which deletes each item in that collection.
-------------------------- Example 3 --------------------------
| Copy Code |
|
|---|---|
Get-CsRegistrarConfiguration | Where-Object {$_.EnableDHCPServer -eq $True} | Remove-CsRegistrarConfiguration
|
|
In Example 3, all the registrar configuration settings where the EnableDHCPServer property is True are deleted. To carry out this task, the command first calls Get-CsRegistrarConfiguration without any parameters; this 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 (-eq) True ($True). In turn, the filtered collection is piped to Remove-CsRegistrarConfiguration, which deletes each item in the collection.