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

Returns information about the common area phones managed using Microsoft Communication Server 2010. Common area phones are phones that are located in building lobbies, employee lounges, or other areas where they are likely to be used by a number of different people, and for a number of different users.

Syntax

add-attachmentfilterentry -Name <String> -Type <ContentType | FileName> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Optional

User ID Parameter

Unique identifier for the common area phone. Common area phones are identified using the Active Directory distinguished name of the associated contact object. Common area phones, by default, use a GUID (globally unique identifier) as their common name; that means phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com.

Note. By using the –DN parameter when calling New-CsCommonAreaPhone, administrators can give common area phones a more user-friendly common name (e.g., Building 14 Lobby as opposed to {ce84964a-c4da-4622-ad34-c54ff3ed361f}).

Filter

Optional

String

Enables you to limit the returned data by filtering on Microsoft Communications Server-specific attributes. For example, you can limit returned data to common area phone contact objects that have been assigned a specific voice policy, or contacts that have not been assigned a specific voice policy.

The -Filter parameter uses the same Windows PowerShell filtering syntax that is used by the Where-Object cmdlet. For example, a filter that returns only contacts that have been enabled for Enterprise Voice would look like this, with EnterpriseVoiceEnabled representing the Active Directory Domain Services attribute, -eq representing the comparison operator (equal to), and $True (a built-in Windows PowerShell variable) representing the filter value:

{EnterpriseVoiceEnabled -eq $True}

For details, see the about_communications_server_filters Help topic.

LdapFilter

String

Enables you to limit the returned data by filtering on generic Active Directory Domain Services attributes (that is, attributes that are not specific to Microsoft Communications Server). For example, you can limit returned data to contact objects that have been assigned to a specific department or are located in a specific building.

The -LDAPFilter parameter uses the LDAP query language when creating filters. For example, a filter that returns only contact objects representing common area phones in the city of Redmond would look like this:

-LDAPFilter "l=Redmond"

In the preceding filter, "l" represents the Active Directory Domain Services attribute (locality); "=" represents the comparison operator (equal to); and "Redmond" represents the filter value.

For details, see the about_ldap_filters Help topic.

OU

Optional

Active Directory distinguished name

Enables you to limit the retrieved information to contact objects found in a specific Active Directory Domain Services organizational unit (OU). This returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs - AccountsPayable and AccountsReceivable – common area phone information will be returned from each of these OUs.

When specifying an OU, use the distinguished name of that container; for example: OU=Finance,dc=litwareinc,dc=com.

DomainController

Optional

String

Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the -DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (for example, atl-mcs-001.litwareinc.com).

Credential

Optional

PS Credential object

Enables you to run the Get-CsCommonAreaPhone cmdlet under alternate credentials. This might be required if the account you used to log on to the Windows does not have the necessary privileges required to work with contact objects.

To use the -Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. For details, see the Get-Credential cmdlet Help topic.

ResultSize

Optional

Integer

Enables you to limit the number of records returned by a command. For example, to return seven common area phones (regardless of how many common area phones are in your forest) include the -ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which 7 phones will be returned. If you set the ResultSize to 7 but you have only three common area phones in your forest, the command will return those three phones, and then complete without error.

The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0 the command will run, but no data will be returned.

Detailed 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 congregate (and might need to use the phone). This presents administrators with a management challenge. After all, phone use in Microsoft Communications Server is typically maintained by using various voice policies and dial plans, policies and plans that are assigned to individual users. How can you manage a device that isn’t associated with an individual user?

One solution is to create Active Directory contact objects for all your common area phones. (These contact objects can be created 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, all you have to do is create a voice policy that prohibits call transfers and call parking, 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"

Get-CsCommonAreaPhone provides a way for you to retrieve information about the common area phones configured for use in your organization. If you call Get-CsCommonAreaPhone 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 OU; all the contacts objects located in a specified building; etc.

Return Types

Get-CsCommonAreaPhone returns instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object.

Examples

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

Copy Code
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 Get-CsCommonAreaPhone without any parameters.

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

Copy Code
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 (-eq) "Building 14 Lobby".

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

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

The preceding command returns all the common area phones that have an Active Directory display name that begins with the characters "Building 14". To do this, Get-CsCommonAreaPhone 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".

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

Copy Code
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 (-eq) tel:+14255551234. Because LineUris must be unique, this command will never return more than a single item.

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

Copy Code
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 DialPlan. 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 (-eq) a null value ($Null). If a common area phone has not explicitly been assigned a dial plan, then it automatically uses the global dial plan or, if available, the dial plan assigned to the site.

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

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

The preceding command returns a collection of all the common area phones that have a contact object in the Telecommunications OU in Active Directory. To do this, Get-CsCommonAreaPhone 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.