Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Set-CsVoicePolicy

 

Topic Last Modified: 2013-03-25

Modifies an existing voice policy. This cmdlet was introduced in Lync Server 2010.

Set-CsVoicePolicy [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Set-CsVoicePolicy [-Instance <PSObject>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-AllowCallForwarding <$true | $false>] [-AllowPSTNReRouting <$true | $false>] [-AllowSimulRing <$true | $false>] [-CallForwardingSimulRingUsageType <VoicePolicyUsage | InternalOnly | CustomUsage>] [-Confirm [<SwitchParameter>]] [-CustomCallForwardingSimulRingUsages <PSListModifier>] [-Description <String>] [-EnableBWPolicyOverride <$true | $false>] [-EnableCallPark <$true | $false>] [-EnableCallTransfer <$true | $false>] [-EnableDelegation <$true | $false>] [-EnableMaliciousCallTracing <$true | $false>] [-EnableTeamCall <$true | $false>] [-EnableVoicemailEscapeTimer <$true | $false>] [-Force <SwitchParameter>] [-Name <String>] [-PreventPSTNTollBypass <$true | $false>] [-PstnUsages <PSListModifier>] [-PSTNVoicemailEscapeTimer <Int64>] [-Tenant <Guid>] [-VoiceDeploymentMode <OnPrem | Online | OnlineBasic | OnPremOnlineHybrid>] [-WhatIf [<SwitchParameter>]]

This example sets the AllowSimulRing property to False for the per-user policy UserVoicePolicy2, meaning any users assigned this policy are not enabled for simultaneous ring, a feature that determines whether a second phone (such as a mobile phone) can be set to ring every time the user’s office phone rings. This command also removes "Local" from the list of PSTN usages for this policy. (Note that the Identity parameter is not explicitly specified. The Identity parameter is a positional parameter, therefore if you put the identity value first in the list of parameters you don’t need to explicitly state that it’s the Identity.)

Set-CsVoicePolicy UserVoicePolicy2 -AllowSimulRing $false -PstnUsages @{remove="Local"}

This example modifies the voice policy for site Redmond so that all the PSTN usages defined for the organization are applied to this policy. The first line in this example calls the Get-CsPstnUsage cmdlet to retrieve the global set of PSTN usages for the organization and save that set in the variable $a. The second line calls the Set-CsVoicePolicy cmdlet to modify the voice policy for site Redmond. A value is passed to the PstnUsages parameter to replace the current list of usages for the policy with the list contained in the global set of PSTN usages. Note the syntax of the replace value: $a.Usage. This refers to the Usage property of the PSTN usage settings, which contains the list of PSTN usages.

$a = Get-CsPstnUsage
Set-CsVoicePolicy -Identity site:Redmond -PstnUsages @{replace=$a.Usage}

This cmdlet modifies an existing voice policy. 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 change 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 Set-CsVoicePolicy cmdlet locally: 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 "Set-CsVoicePolicy"}

 

Parameter Required Type Description

AllowCallForwarding

Optional

Boolean

If this parameter is set to True, users assigned to this policy can forward calls. If this parameter is set to False, calls cannot be forwarded.

AllowPSTNReRouting

Optional

Boolean

When this parameter is set to True, calls made to internal numbers homed on another pool will be routed through the public switched telephone network (PSTN) when the pool or WAN is unavailable.

AllowSimulRing

Optional

Boolean

Simultaneous ring is a feature that allows multiple phones to ring when a single number is dialed. Setting this parameter to True enables simultaneous ring. If this parameter is set to False, simultaneous ring cannot be configured for any user assigned to this policy.

CallForwardingSimulRingUsageType

Optional

CallForwardingSimulRingUsageType

Provides a way for administrators to manage call forwarding and simultaneous ringing. Allowed values are:

* VoicePolicyUsage – The default voice policy usage is used to manage call forwarding and simultaneous ringing on all calls. This is the default value.

* InternalOnly – Call forwarding and simultaneous ringing are limited to calls made from one Lync user to another.

* CustomUsage. A custom PSTN usage will be used to manage call forwarding and simultaneous ringing. This usage must be specified using the CustomCallForwardingSimulRingUsages parameter.

Confirm

Optional

SwitchParameter

Prompts you for confirmation before executing the command.

CustomCallForwardingSimulRingUsages

Optional

PSListModifier

Custom PSTN usage used to manage call forwarding and simultaneous ringing. To add a custom usage to voice policy use syntax similar to this:

-CustomCallForwardingSimulRingUsages @{Add="RedmondPstnUsage"}

To remove a custom usage, use this syntax:

-CustomCallForwardingSimulRingUsages @{Remove="RedmondPstnUsage"}

Note that the usage must exist before it can be used with the CustomCallForwardingSimulRingUsages parameter.

Description

Optional

String

A description of the voice policy.

Maximum length: 1040 characters.

EnableBWPolicyOverride

Optional

Boolean

Policies can be set to limit bandwidth and set various other properties relating to network configuration. Setting this parameter to True will allow override of these policies. In other words, if this parameter is set to True no bandwidth checks will be made, calls will go through regardless of the call admission control (CAC) settings.

EnableCallPark

Optional

Boolean

The Call Park application allows a call to be held, or parked, at a certain number within a range of numbers for later retrieval. Setting this parameter to True enables this application for users assigned this policy. If this parameter is set to False, users assigned to this policy cannot park calls that have been dialed to their phone number.

EnableCallTransfer

Optional

Boolean

Determines whether calls can be transferred to another number. If this parameter is set to True, calls can be transferred; if the parameter is set to False, calls cannot be transferred.

EnableDelegation

Optional

Boolean

Call delegation allows a user to answer calls for another user or make calls on the other user’s behalf. For example, a manager can set up call delegation so that all incoming calls ring both his or her phone and the phone of an administrator. Setting this parameter to True allows users with this policy to set up call delegation. Setting this parameter to False disables call delegation.

EnableMaliciousCallTracing

Optional

Boolean

Malicious call tracing is a standard that is in place to trace calls that a user designates as malicious. These calls can be traced even if caller ID is blocked. The trace is available only to the proper authorities and not to the user. Setting this property to True enables the ability to set a trace on malicious calls.

EnableTeamCall

Optional

Boolean

Team Call allows a user to designate a group of other users whose phones will ring when that user’s number is called. This feature is useful in teams where, for example, anyone from a team can answer incoming calls from customers. Setting this parameter to True enables this feature.

EnableVoicemailEscapeTimer

Optional

Boolean

When set to True, calls to an unanswered mobile device will be routed to the organization voicemail instead of the mobile device provider's voicemail. If a call is answered "too soon" (that is, before the value configured for the PSTNVoicemailEscapeTimer property has elapsed) it will be assumed that the mobile device is not available and the call will be routed to the organization voicemail.

The default value is False.

Force

Optional

SwitchParameter

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

Identity

Optional

XdsIdentity

A unique identifier specifying the scope, and in some cases the name, of the policy.

Instance

Optional

VoicePolicy

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. This object must be of type VoicePolicy and can be retrieved by calling the Get-CsVoicePolicy cmdlet.

Name

Optional

String

A friendly name describing this policy.

PreventPSTNTollBypass

Optional

Boolean

PSTN tolls are more commonly known as long-distance charges. Organizations can sometimes bypass these tolls by implementing a Voice over Internet Protocol (VoIP) solution that enables branch offices to connect via network calls. Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls.

PstnUsages

Optional

PSListModifier

A list of PSTN usages available to this policy. The PSTN usage ties a voice policy to a phone route.

Any string value can be placed into this list, as long as the value exists in the current global list of PSTN usages. (Duplicate strings are not allowed; all string must be unique.) The list of PSTN usages can be retrieved by calling the Get-CsPstnUsage cmdlet.

Keep in mind that if you use this parameter to remove all PSTN usages from the policy, users granted this policy will not be able to make outbound PSTN calls.

PSTNVoicemailEscapeTimer

Optional

Int64

Amount of time (in milliseconds) used to determine whether or not a call has been answered "too soon." If a response is received within this time interval Lync Server will assume that the mobile device is not available and automatically switch the call to the organization's voicemail. If no response is received before the time interval is reached then the call will be allowed to proceed.

The default value is 1500 milliseconds.

Tenant

Optional

Guid

Globally unique identifier (GUID) of the Lync Online tenant account whose voice policy is to be modified. 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

VoiceDeploymentMode

Optional

VoiceDeploymentMode

Allowed values are:

* OnPrem

* Online

* OnlineBasic

* OnPremOnlineHybrid

The default value is OnPrem.

WhatIf

Optional

SwitchParameter

Describes what would happen if you executed the command without actually executing the command.

Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object. Accepts pipelined input of voice policy objects.

This cmdlet does not return a value or object. Instead, it configures instances of the Microsoft.Rtc.Management.WritableConfig.Voice.VoicePolicy object.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.