Edit

Share via


Get-CsHostedVoicemailPolicy

Retrieves a hosted voice mail policy. This cmdlet was introduced in Lync Server 2010.

Syntax

Identity (Default)

Get-CsHostedVoicemailPolicy
    [[-Identity] <XdsIdentity>]
    [-Tenant <Guid>]
    [-LocalStore]
    [<CommonParameters>]

Filter

Get-CsHostedVoicemailPolicy
    [-Tenant <Guid>]
    [-Filter <String>]
    [-LocalStore]
    [<CommonParameters>]

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

Examples

Example 1

Get-CsHostedVoicemailPolicy

This command returns all defined hosted voice mail policies for the Skype for Business Server 2015 implementation.

Example 2

Get-CsHostedVoicemailPolicy -Identity ExRedmond

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

Example 3

Get-CsHostedVoicemailPolicy -Filter tag:*

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

Parameters

-Filter

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Filter
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:XdsIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Identity
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LocalStore

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy