Modifies an existing collection of UserServices configuration settings. The User Server service is used to help maintain presence information and manage online conferencing.
Syntax
Set-CsUserServicesConfiguration [-Identity <XdsIdentity>] [-AnonymousUserGracePeriod <TimeSpan>] [-Confirm [<SwitchParameter>]] [-DeactivationGracePeriod <TimeSpan>] [-DefaultSubscriptionExpiration <Int64>] [-Force <SwitchParameter>] [-MaintenanceTimeOfDay <DateTime>] [-MaxContacts <UInt16>] [-MaxPersonalNotes <UInt32>] [-MaxScheduledMeetingsPerOrganizer <UInt32>] [-MaxSubscriptionExpiration <Int64>] [-MaxSubscriptions <UInt16>] [-MinSubscriptionExpiration <Int64>] [-SubscribeToCollapsedDG <$true | $false>] [-WhatIf [<SwitchParameter>]] |
Set-CsUserServicesConfiguration [-AnonymousUserGracePeriod <TimeSpan>] [-Confirm [<SwitchParameter>]] [-DeactivationGracePeriod <TimeSpan>] [-DefaultSubscriptionExpiration <Int64>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-MaintenanceTimeOfDay <DateTime>] [-MaxContacts <UInt16>] [-MaxPersonalNotes <UInt32>] [-MaxScheduledMeetingsPerOrganizer <UInt32>] [-MaxSubscriptionExpiration <Int64>] [-MaxSubscriptions <UInt16>] [-MinSubscriptionExpiration <Int64>] [-SubscribeToCollapsedDG <$true | $false>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Xds Identity |
Unique identifier for the User Server 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:UserServer:atl-cs-001.litwareinc.com. |
|
Instance |
Optional |
UserServicesSettings object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
|
MaintenanceTimeOfDay |
Optional |
DateTime |
Indicates the time of day when regularly-scheduled database maintenance (such as the purging of outdated records) takes place. This value must be specified as a date-time value; you can use either the 24-hour format (e.g., "14:00") or the 12-hour format (for example, "2:00 PM"). The default value for MaintenanceTimeOfDay is 1:00 AM (01:00:00). |
|
MinSubscriptionExpiration |
Optional |
Integer |
Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user’s client application) can request the length of time that the subscription remains valid before it must be renewed. The MinSubscriptionExpiration property represents the minimum amount of time that clients can be granted. For example, if the minimum time is set to 1200 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 1200 seconds. The minimum subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. The default value is 1200 seconds (20 minutes). |
|
MaxSubscriptionExpiration |
Optional |
Integer |
Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user’s client application) can request the length of time that the subscription remains valid before it must be renewed. The MaxSubscriptionExpiration property represents the maximum amount of time that clients can be granted. For example, if the maximum time is set to 28800 seconds and a client requests a timeout interval of 86400 seconds, the client will be given the maximum allowed expiration period: 28800 seconds. The maximum subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. The default value is 43200 seconds (12 hours). |
|
DefaultSubscriptionExpiration |
Optional |
Integer |
Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user’s client application) can request the length of time that the subscription remains valid before it must be renewed. If no such request is issued, then the subscription is set to the value specified by the DefaultSubscriptionExpiration property. The default subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. The default value is 28800 seconds (8 hours). |
|
AnonymousUserGracePeriod |
Optional |
TimeSpan |
Represents the amount of time an anonymous (unauthenticated) user can remain in a meeting before an authenticated user must join that meeting. For example, if this value is set to 15 minutes an anonymous user can stay in the meeting for, at most, 15 minutes before an authenticated user must join. If an authenticated user joins before the grace period expires, the anonymous user can stay in the meeting until the meeting ends. If an authenticated user does not join before the grace period expires then the anonymous user will be removed from the meeting. The AnonymousUserGracePeriod must be specified using the following format: minutes:seconds (e.g., 00:30:00 for 30 minutes). The maximum grace period allowed is one hour (1:00:00). The default value is 10 minutes (00:10:00). |
|
DeactivationGracePeriod |
Optional |
TimeSpan |
The maximum amount of time that a meeting can remain active. This value must be specified using the following format: days:hours:minutes:seconds. For example, to enable a meeting to last for 60 hours you would use this format: 2:12:00:00 (2 days: 12 hours: 0 minutes: 0 seconds.) The DeactivationGracePeriod must be between 8 hours and 365 days, inclusive. The default value is 8 hours. |
|
MaxScheduledMeetingsPerOrganizer |
Optional |
Integer |
The maximum number of meetings that a single user can serve as organizer for at a given time. The default value is 1000. This means that, if a user is already the organizer for 1000 meetings, his or her request to schedule a new meeting (meeting number 1001) will fail. |
|
MaxSubscriptions |
Optional |
Integer |
The maximum number of SIP subscribe dialogs a user can have open at any one time. A subscribe dialog represents a request for SIP resources. |
|
MaxContacts |
Optional |
Integer |
The maximum number of contacts a user can have. The default value is 250. The MaxContacts property represents the absolute maximum number of contacts a user can have. However, you can use the CsClientPolicy cmdlets to limit certain users to a maximum number of contacts lower than the value of MaxContacts. |
|
MaxPersonalNotes |
Optional |
Integer |
Indicates the maximum number of personal notes that are stored in the user’s note history. By default, the last 3 personal notes are maintained in the note history. The maximum number of notes that can be maintained in the history is 10. |
|
SubscribeToCollapsedDG |
Optional |
Boolean |
If set to True (the default value), client applications will be allowed to subscribe to distribution groups that are not currently expanded in the contact list; this enables the client to maintain up-to-minute presence information for each member of the group. If set to False, client applications will not be allowed to subscribe to “collapsed” groups. |
|
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
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 Set-CsUserServicesConfiguration cmdlet provides a way for administrators to modify information about any (or all) of the User Server configuration settings currently in use.
Return Types
Set-CsUserServicesConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.UserServices.UserServicesSettings object.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Set-CsUserServicesConfiguration -Identity site:Redmond -AnonymousUserGracePeriod "00:30:00" |
|
The command shown in Example 1 modifies the User Server configuration settings for the Redmond site (-identity site:Redmond). In this example, the AnonymousUserGracePeriod is set to 30 minutes (0 hours: 30 minutes: 0 seconds).
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Set-CsUserServicesConfiguration -Identity site:Redmond -MaintenanceTimeOfDay "13:30" |
|
In Example 2, the MaintenanceTimeOfDay property is modified for the User Server configuration settings applied to the Redmond site. This is done by using the -MaintenanceTimeOfDay parameter and the parameter value 13:30. That sets the maintenance time of day to 1:30 PM: 13 hours and 30 minutes on a 24-hour clock.
-------------------------- Example 3 --------------------------
| Copy Code |
|
|---|---|
Get-CsUserServicesConfiguration -Filter "service:*" | Set-CsUserServicesConfiguration -MaxContacts 300 |
|
The preceding command retrieves all the User Server configuration settings applied at the service scope and then modifies the allowed number of contacts for each of these items. To carry out this task, the command first uses Get-CsUserServicesConfiguration and the -Filter parameter to retrieve all the settings configured at the service scope; the filter value "service:*" limits the returned data to settings that have an Identity that begins with the characters "service:". This filtered collection is then passed to Set-CsUserServicesConfiguration, which takes each item in the collection and sets the MaxContacts property to 300.
-------------------------- Example 4 --------------------------
| Copy Code |
|
|---|---|
Get-CsUserServicesConfiguration | Where-Object {$_.MaxContacts -gt 300} | Set-CsUserServicesConfiguration -MaxContacts 300
|
|
In Example 5, all User Server configuration settings that allow users more than 300 contacts are modified; after the modifications are made, no settings will allow for more than 300 contacts. To do this, the command first calls Get-CsUserServicesConfiguration without any additional parameters; this returns a collection of all the User Server configuration settings currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the MaxContacts property is greater than (-gt) 300. In turn, the filtered collection is piped to Set-CsUserServicesConfiguration, which takes each item in the filtered collection and changes the maximum number of allowed contacts to 300.