[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Creates a new collection of settings used to manage Microsoft Communicator “14” Phone Edition. These settings enable you to configure such things as the required security mode, and to specify whether or not the phone should automatically be locked after a specified period of inactivity.


New-CsUCPhoneConfiguration -Identity <XdsIdentity> [-CalendarPollInterval <TimeSpan>] [-Confirm [<SwitchParameter>]] [-EnforcePhoneLock <$true | $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-LoggingLevel <Off | Low | Medium | High>] [-MinPhonePinLength <Byte>] [-PhoneLockTimeout <TimeSpan>] [-SIPSecurityMode <Low | Medium | High>] [-Voice8021p <Byte>] [-VoiceDiffServTag <Byte>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description




Represents the unique identifier to be assigned to the new collection of UC phone configuration settings. Because you can only create new collections at the site scope the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond".




Indicates how often the UC device retrieves information from your Microsoft Outlook calendar. The value must be specified using the format hours:minutes:seconds; for example, to set the time interval to 1 hour (the maximum allowed interval) use this syntax: -CalendarPollInterval "01:00:00". The default value is 3 minutes (00:03:00).




Determines whether or not UC phones are automatically locked after the number of minutes specified by PhoneLockTimeout. The default value is True.




Specifies the length of time, in minutes, that a UC phone will remain idle before automatically locking.

This value must be less than 01:00:00 (1 hour). The default value is 00:10:00 (10 minutes).




Specifies the minimum number of digits required for Personal Identification Numbers (PINs).

Minimum value: 4

Maximum value: 15

Default: 6




Specifies the level of security that the server applies to SIP sessions initiated by a UC phone.

Valid values are:

Low (allow any type of authorization or transport).

Medium (NTLM or Kerberos is required for user authentication).

High (NTLM or Kerberos is required for user authentication and TLS is required for SIP connections).

The default value is High




Specifies the decimal representation of the 6-bit DiffServ Code Point (DSCP) priority marking that defines the Per Hop Behavior (PHB) for IP packets passed by the UC phones that are managed by this server.

This value must be between 0 and 63, inclusive. The default value is 40.




Specifies the user priority value (the 802.1p value) for voice traffic within the Microsoft Communications Server deployment.

This setting is effective only within networks in which switches and bridges are 802.1p-capable. The minimum value for this property is 0 and the maximum value is 7. The default value is 0.




Enables logging on the UC device; valid values are Off; Low; Medium; and High. The default value is Off.



Switch Parameter

Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet.



Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.



Switch Parameter

Describes what would happen if you executed the command without actually executing the command.



Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

Communicator “14” Phone Edition represents the merging of two great ideas: the telephone, and Communicator. Communicator “14” Phone Edition uses special hardware (that is, a Communicator-compatible telephone) that can function as a Voice over IP telephone. That’s good; even better is the fact that this hardware can also act as a Communicator-like endpoint: you can set your current status; check the status of your Communicator contacts; search for new contacts; and carry out many of the other activities you are used to doing with Communicator. Furthermore, you can do all this with or without a computer: all you need is a place to plug in your Communicator-enabled phone.

Obviously these are powerful and sophisticated devices. And that’s potentially a problem: many organizations are reluctant to distribute devices such as these unless they have a good way to manage and maintain the hardware and the way the hardware is used. Fortunately, that’s not a problem with Microsoft Communications Server 2010; in fact, Communications Server 2010 ships with a number of cmdlets that let you manage your Communicator phones. Among other things, you can use the UC (Unified Communications) phone configuration cmdlets to control such things as the minimum length of the PIN number used to log on to the phone and whether or not the phone will automatically lock itself after a specified period of inactivity.

UC phone configuration settings can be applied at either the global scope or at the site scope. (Settings applied at the site scope take precedence over settings applied at the global scope.) When you first install Communications Server, a single set of UC phone configuration settings is created and applied at the global scope. However, at any time after that you can use the New-CsUCPhoneConfiguration cmdlet to create a collection of settings that are applied at the site scope (with a limit of one set per site). This lets you tailor UC phone management to the unique needs of each individual site.

New-CsUCPhoneConfiguration enables you to create new UC phone settings at the site scope. As noted, there can only be one collection of settings per site. For example, suppose you try to create a collection of settings that has the Identity site:Redmond, but the Redmond site already has a set of UC phone settings assigned to it. In that case, your command will fail. Instead, you must do one of two things: either remove the existing settings and then use New-CsUCPhoneConfiguration to create a new collection of settings; or simply use Set-CsUCPhoneConfiguration to modify the existing settings.

Note that you cannot create a new collection of settings at the global scope. Instead, the only thing you can do at the global scope is use Set-CsUCPhoneConfiguration to modify the existing settings.

Return Types

Creates instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Voice.UcPhoneSettings object.


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

Copy Code
New-CsUCPhoneConfiguration -Identity site:Redmond -CalendarPollInterval "00:10:00" -LoggingLevel "Medium"

The preceding command creates a new collection of UC phone settings for the Redmond site. In this example, two optional parameters are included along with the required parameter -Identity: -CalendarPollInterval, which sets the calendar polling time to every 10 minutes (00 hours: 10 minutes: 00 seconds); and -LoggingLevel, which sets the UC phone logging level to Medium. As soon as this command completes, the new settings will be applied to the Redmond site and users in that site will have their UC phones governed by the new settings. Note that this command will fail if the Redmond site already has a collection of UC phone settings.

-------------------------- Example 2 ------------------------

Copy Code
$x = New-CsUCPhoneConfiguration -Identity site:Redmond -InMemory
$x.CalendarPollInterval = "00:10:00" 
$x.LoggingLevel = "Medium"
Set-CsUCPhoneConfiguration -Instance $x

Example 2 demonstrates the use of the -InMemory parameter; this parameter enables you to create a new set of UC phone settings that exists in memory only. (These settings are stored in the variable $x.) After this virtual collection has been created, you can modify the in-memory-only settings using commands similar to those shown in lines 2 and 3 of the example: in line 2, the CalendarPollInterval property is set the 10 minutes (00 hours: 10 minutes: 00 seconds), and in line 3 the LoggingLevel property is set to Medium. After you have finished modifying the property values, you can then use Set-CsUCPhoneConfiguration to turn the virtual settings stored in $x into an actual collection of settings applied, in this case, to the Redmond site. Note that, with the use of -InMemory, the settings are not actually applied until you call Set-CsUCPhoneConfiguration. If you do not call this cmdlet, then your virtual settings will disappear when you terminate your Windows PowerShell session or when you delete the variable $x.