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

Enables you to modify management options for Microsoft Communicator “14” Phone Edition. This includes such things as the required security mode and whether or not the phone should automatically be locked after a specified period of inactivity.

Syntax

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

Parameters

Parameter Required Type Description

Identity

Optional

XdsIdentity

Represents the unique identifier to be assigned to the collection of UC phone configuration settings. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope use syntax similar to this: -Identity site:Redmond. Note that you cannot use wildcard characters when specifying an Identity.

If this parameter is omitted then Set-CsUCPhoneConfiguration will modify the global settings.

Instance

Optional

UcPhoneSettings object

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

CalendarPollInterval

Optional

TimeSpan

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).

EnforcePhoneLock

Optional

Boolean

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

PhoneLockTimeout

Optional

Timespan

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).

MinPhonePinLength

Optional

Byte

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

Minimum value: 4

Maximum value: 15

Default: 6

SIPSecurityMode

Optional

SIPSecurityMode

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

VoiceDiffServTag

Optional

Byte

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.

Voice8021p

Optional

Byte

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.

LoggingLevel

Optional

String

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

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

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-enabled 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.

In addition to creating new collections of UC phone settings you can also use the Set-CsUCPhoneConfiguration cmdlet to modify the property values of an existing collection. For example, by default logging is disabled for UC phones. To enable logging at the global level, you can use Set-CsUCPhoneConfiguration to change the value of the global collection’s LoggingLevel property to True.

Return Types

Set-CsUCPhoneConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Voice.UcPhoneSettings object.

Examples

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

Copy Code
Set-CsUCPhoneConfiguration -SIPSecurityMode "Medium"

The command shown in Example 1 sets the SIP security mode of the global UC phone settings to Medium. If you do not include the -Identity parameter Set-CsUCPhoneConfiguration will automatically modify the global settings.

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

Copy Code
Set-CsUCPhoneConfiguration -Identity site:Redmond -PhoneLockTimeout "00:30:00"

The preceding command modifies the UC phone settings configured for the Redmond site. In this case, the PhoneLockTimeout property is set to 30 minutes; this is done by including the -PhoneLockTimeout parameter and the parameter value "00:30:00" (00 hours: 30 minutes: 00 seconds).

-------------------------- Example 3 --------------------------

Copy Code
Get-CsUCPhoneConfiguration -Filter site: * | Set-CsUCPhoneConfiguration -PhoneLockTimeout "00:30:00"

Example 3 is a variation of the command shown in Example 2. This time, however, the PhoneLockTimeout property is modified for all the UC phone settings configured at the site scope. To do this, the command starts off by calling Get-CsUCPhoneConfiguration; the -Filter parameter and the filter value "site:*" limit the returned data to phone settings configured at the site scope. This filtered collection is then piped to Set-CsUCPhoneConfiguration, which uses the -PhoneLockTimeout parameter and the parameter value "00:30:00" (00 hours: 30 minutes: 00 seconds) to set the phone lock timeout value for each item in the collection to 30 minutes.

-------------------------- Example 4 --------------------------

Copy Code
Get-CsUCPhoneConfiguration | Where-Object {$_.SIPSecurityMode -ne "High" | Set-CsUCPhoneConfiguration -EnforcePhoneLock $True -PhoneLockTimeout "00:30:00"

The preceding command configures the EnforcePhoneLock and the PhoneLockTimeout properties for all the UC phone settings where the SIP security mode is set to either Low or Medium. To perform this task, the command first uses Get-CsUCPhoneConfiguration to return all the UC phone configuration settings in the organization; this information is then piped to the Where-Object cmdlet. In turn, Where-Object picks out only those settings where the SIPSecurityMode property is not equal to (-ne) High; because SIP security can only be set to Low, Medium, or High, this Where-Object clause will end up selecting all the settings where SIPSecurityMode is set to either Low or Medium. The filtered collection is then piped to Set-CsUCPhoneConfiguration, which uses the -EnforcePhoneLock and the -PhoneLockTimeout parameters to modify the phone locking and phone lock timeout properties.

-------------------------- Example 5 --------------------------

Copy Code
Get-CsUCPhoneConfiguration | Where-Object {$_.PhoneLockTimeout -lt "00:10:00" | Set-CsUCPhoneConfiguration -PhoneLockTimeout "00:10:00"

In Example 5, the phone lock timeout value is set to 10 minutes for all the UC phone settings where the PhoneLockTimeout property is currently less than 10 minutes. (In effect, this makes 10 minutes the minimum phone lock timeout value throughout the organization.) To do this, the command first uses Get-CsUCPhoneConfiguration to return a collection of all the UC phone settings currently in use in the organization. This collection is then piped to Where-Object, which picks out only those settings where the PhoneLockTimeout property is less than (-lt) 10 (00 hours: 10 minutes: 00 seconds). In turn, this filtered collection is piped to Set-CsUCPhoneConfiguration, which sets the PhoneLockTimeout value for each item in the collection to 10 minutes.