Syntax


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


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

Parameters

Parameter	Required	Type	Description
Identity	Optional	XdsIdentity	The unique identifier for the hosted voice mail policy you want to retrieve. The Identity includes the scope (in the case of global), the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as HVUserPolicy).
Filter	Optional	String	This parameter allows you to do a wildcard search on the Identity of the hosted voice mail policy. This will retrieve all instances of a hosted voice mail policy where the Identity matches the wildcard pattern specified in the Filter value.
LocalStore	Optional	SwitchParameter	Retrieves the hosted voice mail policy from the local replica of the Central Management store, rather than the Central Management store itself.

Detailed Description

This cmdlet retrieves a policy that specifies how to route unanswered calls to a user to a hosted Exchange Unified Messaging (UM) service.

A user must be enabled for Exchange UM hosted voice mail for this policy to take effect. You can call the Get-CsUser cmdlet and check the HostedVoiceMail property to determine whether a user is enabled for hosted voice mail. (A value of True means the user is enabled.)

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsHostedVoicemailPolicy 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-CsHostedVoicemailPolicy"}

	Copy Code

Input Types

None.

Return Types

This cmdlet returns an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy

Example

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

	Copy Code
Get-CsHostedVoicemailPolicy

This command returns all defined hosted voice mail policies for the Microsoft Lync Server 2010 implementation.

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

	Copy Code
Get-CsHostedVoicemailPolicy -Identity ExRedmond

This command returns the policy settings for the per-user hosted voice mail policy ExRedmond.

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

	Copy Code
Get-CsHostedVoicemailPolicy -Filter tag:*

This command returns the policy settings for all per-user hosted voice mail policies (policies beginning with the tag scope).