Get-CsCommonAreaPhone

Syntax

Get-CsCommonAreaPhone
   [[-Identity] <UserIdParameter>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-LdapFilter <String>]
   [-OU <OUIdParameter>]
   [-ResultSize <Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32]>]
   [<CommonParameters>]

Description

Common area phones are IP telephones that are not associated with an individual user. Instead of being located in someone's office, common area phones are typically located in building lobbies, cafeterias, employee lounges, meeting rooms and other locations where a large number of people are likely to gather. This presents administrators with a management challenge; that's because phone use in Skype for Business Server is typically maintained by using voice policies and dial plans that are assigned to individual users. Common area phones do not have individual users assigned to them.

The solution to this challenge is to create Active Directory contact objects for all your common area phones. (These contact objects can be created by using the New-CsCommonAreaPhone cmdlet.) Like user accounts, these contact objects can be assigned policies and voice plans. As a result, you will be able to maintain control over common area phones even though those phones are not associated with an individual user. For example, if you do not want people to have the ability to transfer or park calls from a common area phone, you can create a voice policy that prohibits call transfers and call parking, and then assign that policy to the common area phone. (Or, more correctly, to the contact object that represents the common area phone.) For example, this command assigns the voice policy CommonAreaPhoneVoicePolicy to all your common area phones:

Get-CsCommonAreaPhone | Grant-CsVoicePolicy -PolicyName "CommonAreaPhoneVoicePolicy"

The Get-CsCommonAreaPhone cmdlet provides a way for you to retrieve information about the common area phones configured for use in your organization. If you call the Get-CsCommonAreaPhone cmdlet without any parameters, the cmdlet will return information about all your common area phones. Optional parameters provide different ways for you to filter information; for example, you can return all the common area phones that have contact objects in a specified organizational unit (OU), or all the contacts objects located in a specified building.

Examples

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

Get-CsCommonAreaPhone

The command shown in Example 1 returns information about all the common area phones configured for use in the organization. This is done by calling the Get-CsCommonAreaPhone cmdlet without any parameters.

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

Get-CsCommonAreaPhone -Filter {DisplayName -eq "Building 14 Lobby"}

In Example 2, the common area phone with the Active Directory display name "Building 14 Lobby" is returned. This task is carried out by including the Filter parameter and the filter value {DisplayName -eq "Building 14 Lobby"}; that filter value limits returned objects to common area phones where the DisplayName property is equal to "Building 14 Lobby".

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

Get-CsCommonAreaPhone -Filter {DisplayName -like "Building 14*"}

Example 3 returns all the common area phones that have an Active Directory display name that begins with the characters "Building 14". To do this, the Get-CsCommonAreaPhone cmdlet is called, along with the Filter parameter and the filter value {DisplayName -like "Building 14*"}. The filter value uses the -like operator and the wildcard string "Building 14*" to limit returned data to phones where the DisplayName property begins with "Building 14" (for example, "Building 14 Lobby", "Building 14 Cafeteria", etc.).

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

Get-CsCommonAreaPhone -Filter {LineUri -eq "tel:+14255551234"}

In Example 4, a single common area phone is returned: the phone that has a LineUri property equal to "tel:+14255551234". Because LineUris must be unique, this command will never return more than a single item.

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

Get-CsCommonAreaPhone -Filter {DialPlan -eq $Null}

The command shown in Example 5 returns information about all the common area phones that have not been assigned a dial plan. This is done by using the Filter parameter and the filter value {DialPlan -eq $Null}; that limits returned data to phones where the DialPlan property is equal to a null value. If a common area phone has not explicitly been assigned a dial plan, then it automatically uses the global dial plan or, if one exists, the dial plan assigned to the site.

-------------------------- Example 6 --------------------------

Get-CsCommonAreaPhone -OU "ou=Telecommunications,dc=litwareinc,dc=com"

Example 6 returns a collection of all the common area phones that have a contact object in the Telecommunications OU in Active Directory Domain Services. To do this, the Get-CsCommonAreaPhone cmdlet is called along with the OU parameter; the parameter value limits the returned objects to phones that have contacts objects in the OU with the distinguished name ou=Telecommunications,dc=litwareinc,dc=com.

Parameters

-Credential

-DomainController

-Filter

-Identity

-LdapFilter

-OU

-ResultSize

Inputs

String

Represents the Identity of the common area phone.

Outputs

Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact

Related Links

• Move-CsCommonAreaPhone
• New-CsCommonAreaPhone
• Remove-CsCommonAreaPhone
• Set-CsCommonAreaPhone