Get-CsUCPhoneConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]

Get-CsUCPhoneConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]

Parameters

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 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 as 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.) The Get-CsUCPhoneConfiguration cmdlet enables you to retrieve information about the UC phone settings current employed throughout your organization.

Get-CsUCPhoneConfiguration returns instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Voice.UcPhoneSettings object.

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

	Copy Code
Get-CsUCPhoneConfiguration

The command shown in Example 1 returns all of the Unified Communications phone configuration settings currently in use in the organization. Calling Get-CsUCPhoneConfiguration without any additional parameters always returns a complete collection of phone configuration settings.

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

	Copy Code
Get-CsUCPhoneConfiguration -Identity site:Redmond

In Example 2, only the UC phone configuration settings that have the Identity site:Redmond are returned. Because Identities must be unique, this command will never return more than one collection of phone configuration settings.

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

	Copy Code
Get-CsUCPhoneConfiguration -Filter site:*

In the preceding command, all the Unified Communications phone settings that have been configured at the site scope are returned. To do this, Get-CsUCPhoneConfiguration is called, along with the -Filter parameter; the filter value "site:*" limits the returned data to settings where the Identity property (the only property you can filter on) begins with the string value "site:". By definition, any settings that have an Identity that begins with the string value "site:" are settings that have been configured at the site scope.

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

	Copy Code
Get-CsUCPhoneConfiguration | Where-Object {$_.SIPSecurityMode -eq "Medium"}

Example 4 returns the UC phone configuration settings where the SIP security mode is set to Medium. (SIP security can be set to Low, Medium, or High.) To carry out this task, the command first uses Get-CsUCPhoneConfiguration without any additional parameters in order to return a collection of all the Unified Communications phone settings configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the SIPSecurityMode property is equal to (-eq) Medium.

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

	Copy Code
Get-CsUCPhoneConfiguration | Where-Object {$_.EnforcePhoneLock -eq $False -or $_.MinPhonePinLength -lt 6}

In Example 5, all the UC phone settings are returned that meet one or both of the following criteria: 1) phone locking is not enforced; and/or, 2) the minimum PIN length is less than 6 digits. To do this, the command first calls Get-CsUCPhoneConfiguration to return a collection of all the Unified Communications phone settings currently in use in the organization. This collection is then piped to Where-Object, which selects those items that meet one (or both) of the following criteria: 1) the EnforcePhoneLock property is equal to (-eq) False ($False); and/or, 2) the MinPhoneLength property is less than (-lt) 6.

The -or operator tells Where-Object to pick settings that meet either (or both) of the criteria. To pick settings that meet both the criteria (in this case, meaning that phone locking is not enforced and the PIN length is less than 6) use the -and operator:

Where-Object {$_.EnforcePhoneLock -eq $False -and $_.MinPhonePinLength -lt 6}