Topic Last Modified: 2013-08-13

Returns information about one or more voice policies configured for your organization. This cmdlet was introduced in Lync Server 2010.

Syntax

Get-CsVoicePolicy [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Get-CsVoicePolicy [-Filter <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-LocalStore <SwitchParameter>] [-Tenant <Guid>]

Examples

EXAMPLE 1

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

Copy Code 
Get-CsVoicePolicy

EXAMPLE 2

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

Copy Code 
Get-CsVoicePolicy -Identity UserPolicy1

EXAMPLE 3

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.

Copy Code 
Get-CsVoicePolicy -Filter tag*

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"}

Parameters

Parameter Required Type Description

Filter

Optional

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

Identity

Optional

Microsoft.Rtc.Management.Xds.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.

LocalStore

Optional

System.Management.Automation.SwitchParameter

Retrieves the voice policy from the local replica of the Central Management store, rather than the Central Management store itself.

Tenant

Optional

System.Guid

Globally unique identifier (GUID) of the Lync Online tenant account whose voice policy is to be retrieved. For example:

–Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"

You can return the tenant ID for each of your tenants by running this command:

Get-CsTenant | Select-Object DisplayName, TenantID

If you are using a remote session of Windows PowerShell and are connected only to Lync Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment.

Input Types

None.

Return Types

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

See Also