Modifies the property values in 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 2010 to keep track of the status, and whereabouts, of the user.
Syntax
Set-CsRegistrarConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-DefaultEndpointExpiration <Int32>] [-EnableDHCPServer <$true | $false>] [-Force <SwitchParameter>] [-MaxEndpointExpiration <Int32>] [-MaxEndpointsPerUser <UInt16>] [-MinEndpointExpiration <Int32>] [-WhatIf [<SwitchParameter>]] |
Set-CsRegistrarConfiguration [-Confirm [<SwitchParameter>]] [-DefaultEndpointExpiration <Int32>] [-EnableDHCPServer <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-MaxEndpointExpiration <Int32>] [-MaxEndpointsPerUser <UInt16>] [-MinEndpointExpiration <Int32>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Xds Identity |
Unique identifier for the registrar configuration settings to be modified. To modify the global settings, use this syntax: -Identity global. To modify settings configured at the site scope, use syntax similar to this: -Identity site:Redmond. To modify settings at the service level, use syntax like this: -Identity service:Registrar:atl-cs-001.litwareinc.com Note that registrar settings can only be applied to the Registrar service. An error message will occur if you try to apply these settings to any other service. |
|
Instance |
Optional |
RegistrarSettings object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
|
DefaultEndpointExpiration |
Optional |
Integer |
When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. The DefaultEndpointExpiration property represents the expiration timeout interval for clients that do not request a specific timeout value. The DefaultEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). The default value is 600 (10 minutes). |
|
MaxEndpointExpiration |
Optional |
Integer |
When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. The MaxEndpointExpiration property represents the maximum amount of time that clients can be granted. For example, if the maximum time is set to 600 seconds and a client requests a timeout interval of 800 seconds, the client will be given the maximum allowed expiration period: 600 seconds. The MaxEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). The default value is 900. |
|
MinEndpointExpiration |
Optional |
Integer |
When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. The MinEndpointExpiration property represents the minimum amount of time that clients can be granted. For example, if the minimum time is set to 600 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 600 seconds. The MinEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). The default value is 300. |
|
MaxEndpointsPerUser |
Optional |
Integer |
Indicates the maximum number of endpoints a user can simultaneously have connected to the system. (For example, a user who is logged on to Communications Server 2010 with both a computer and a cell phone would be using 2 endpoints. MaxEndPointsPerUser must be set to a value between 1 and 64, inclusive. The default value is 8. |
|
EnableDHCPServer |
Optional |
Boolean |
Indicates whether endpoints can use DHCP servers to locate a Registrar. If True, clients will send a DHCP Inform message when they first start; the DHCP server will respond by sending the fully qualified domain name of a Registrar that can be used to log on the user. |
|
Force |
Optional |
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 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 of 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 can be used to modify any (or all) of the registrar configuration collections currently in use in your organization.
Return Types
Set-CsRegistrarConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Registrar.RegistrarSettings object.
Examples
-------------------------- 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 ($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. The net effect: no registrar will allow more than 8 endpoints per user.
-------------------------- Example 3 --------------------------
| Copy Code |
|
|---|---|
Get-CsRegistrarConfiguration -Filter "site:*"| Set-CsRegistrarConfiguration -EnableDHCPServer $False |
|
The command shown in Example 3 disables client registration using DHCP for each site in the organization. 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.