Returns information about the User Server configuration settings in use in your organization. The User Server service is used to help maintain presence information and manage online conferencing.
Syntax
Get-CsUserServicesConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>] |
Get-CsUserServicesConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Xds Identity |
Unique identifier for the User Server 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:UserServer:atl-cs-001.litwareinc.com. If this parameter is omitted then Get-CsUserServicesConfiguration returns all the User Server configuration settings currently in use in your organization. |
|
Filter |
Optional |
String |
Enables you to use wildcards when retrieving one or more collections of UserServices 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:*". |
|
Tenant |
Optional |
GUID |
|
|
LocalStore |
Optional |
Switch Parameter |
Detailed Description
Microsoft Communications Server 2010 relies on the User Server service to help maintain presence information for users and to manage online meetings and conferences. In turn, the CsUserServicesConfiguration cmdlets are used to administer UserServices settings at the global, site, and service scope. (Note that the only service that can host User Server configuration settings is the User Server service itself.) These settings help determine such things as the number of contacts a user can have; the number of meetings a user can have scheduled at any one time; and the length of time that a given meeting can remain active.
The Get-CsUserServicesConfiguration cmdlet provides a way for administrators to retrieve information about any (or all) of the User Server configuration settings currently in use.
Return Types
Get-CsUserServicesConfiguration returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.UserServices.UserServicesSettings object.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Get-CsUserServicesConfiguration |
|
The command shown in Example 1 returns a collection of all the User Server configuration settings currently in use in the organization. This is achieved by calling Get-CsUserServicesConfiguration without any additional parameters.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Get-CsUserServicesConfiguration -Identity site:Redmond |
|
In Example 2, only one collection of User Server configuration settings is returned: the collection with the Identity site:Redmond. Because identities must be unique, this command can never return more than one item.
-------------------------- Example 3 --------------------------
| Copy Code |
|
|---|---|
Get-CsUserServicesConfiguration -Filter "service:*" |
|
Example 3 returns a collection of all the User Server configuration settings that have been applied at the service scope. This is done by calling Get-CsUserServicesConfiguration along with the -Filter parameter; the filter value "service:*" limits the returned data to settings where the Identity begins with the characters "service:". By definition, those are settings configured at the service scope.
-------------------------- Example 4 --------------------------
| Copy Code |
|
|---|---|
Get-CsUserServicesConfiguration | Where-Object {$_.MaxContacts -gt 250}
|
|
The preceding command returns all the User Server configuration settings that allow users to have more than 250 contacts. To do this, the command first calls Get-CsUserServicesConfiguration without any additional parameters in order to return a collection of all the UserServices configurations settings currently in use. That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the MaxContacts property is greater than (-gt) 250.
-------------------------- Example 5 --------------------------
| Copy Code |
|
|---|---|
Get-CsUserServicesConfiguration | Where-Object {$_.AnonymousUserGracePeriod -gt "00:10:00"}
|
|
In Example 5, information is reported for those User Server configuration settings where the anonymous user grace period is longer than 10 minutes. To carry out this task, the command first calls Get-CsUserServicesConfiguration without any additional parameters; this returns a collection of all the User Server configuration settings being used in the organization. The returned collection is then piped to Where-Object, which selects only the settings where the AnonymousUserGracePeriod property is greater than (-gt) 10 minutes (0 hours: 10 minutes: 0 seconds).