Topic Last Modified: 2010-10-01

Returns information about one or more voice policies configured for your organization.

Syntax


`Get-CsVoicePolicy [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]`


`Get-CsVoicePolicy [-Filter <String>] [-LocalStore <SwitchParameter>]`

Parameters

Parameter	Required	Type	Description
Identity	Optional	XdsIdentity	A unique identifier specifying the scope, and in some cases the name, of the policy. If this parameter is omitted, all voice policies for the organization are returned.
Filter	Optional	String	This parameter accepts a wildcard string and returns all voice policies with identities matching that string. For example, a Filter value of site:* will return all voice policies defined at the site level.
LocalStore	Optional	SwitchParameter	Retrieves the voice policy from the local replica of the Central Management store, rather than the Central Management store itself.

Detailed Description

This cmdlet retrieves voice policy information. Voice policies are used to manage such Enterprise Voice-related features as simultaneous ringing (the ability to have a second phone ring each time someone calls your office phone) and call forwarding. Use this cmdlet to retrieve the settings that enable and disable many of these features.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsVoicePolicy cmdlet locally: RTCUniversalUserAdmins, RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsVoicePolicy"}

Input Types

None.

Return Types

This cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object.

Example

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

	Copy Code
Get-CsVoicePolicy

This example displays all the voice policies that have been defined for an organization along with the settings for each.

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

	Copy Code
Get-CsVoicePolicy -Identity UserPolicy1

This example uses the Identity parameter to retrieve the voice policy settings for the per-user policy named UserPolicy1.

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

	Copy Code
Get-CsVoicePolicy -Filter tag*

This example uses the Filter parameter to retrieve all the voice policy settings that can be assigned to users. All per-user voice policies have an Identity in the format tag:<UserVoicePolicy>, so we filter on tag to retrieve all user voice policies.