Article
07/23/2014

New-CsVoicePolicy

Topic Last Modified: 2012-03-25

Creates a new voice policy.

Syntax

New-CsVoicePolicy -Identity <XdsIdentity> [-AllowCallForwarding <$true | $false>] [-AllowPSTNReRouting <$true | $false>] [-AllowSimulRing <$true | $false>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-EnableBWPolicyOverride <$true | $false>] [-EnableCallPark <$true | $false>] [-EnableCallTransfer <$true | $false>] [-EnableDelegation <$true | $false>] [-EnableMaliciousCallTracing <$true | $false>] [-EnableTeamCall <$true | $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-Name <String>] [-PreventPSTNTollBypass <$true | $false>] [-PstnUsages <PSListModifier>] [-WhatIf [<SwitchParameter>]]

Detailed Description

This cmdlet creates a new 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. The policy created by this cmdlet determines whether many of these features are enabled or disabled.

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

Parameters

Parameter	Required	Type	Description
Identity	Required	XdsIdentity	A unique identifier specifying the scope or the name of the policy. Valid values for this cmdlet are site:<site name> (where <site name> is the name of the Microsoft Lync Server 2010 site to which this policy applies, such as site:Redmond), and a string designating a per-user policy, such as RedmondVoicePolicy. A global policy exists by default.
AllowCallForwarding	Optional	Boolean	If this parameter is set to True, calls can be forwarded. If this parameter is set to False, calls cannot be forwarded. Default: True
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. Default: True
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 this feature. If this parameter is set to False, simultaneous ring cannot be configured for any user to which this policy is assigned. Default: True
Description	Optional	String	A description of the voice policy. Maximum length: 1040 characters.
EnableBWPolicyOverride	Optional	Boolean	Policies can be set to manage network configuration, including limiting bandwidth. 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 and calls will go through regardless of the call admission control (CAC) settings. Default: False
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 the application. If this parameter is set to False, users assigned to this policy cannot park calls that have been dialed to their phone number. Default: False
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. Default: True
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 the manager’s 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. Default: True
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, not the user. Setting this property to True enables the ability to set a trace on malicious calls. Default: False
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. Default: True
Name	Optional	String	A displayable name describing this policy. Default: DefaultPolicy
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 by using network calls. Setting this parameter to True will send calls through the PSTN and incur charges rather than going through the network and bypassing the tolls. Default: False
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 strings must be unique.) The list of PSTN usages can be retrieved by calling the Get-CsPstnUsage cmdlet. By default this list is empty. If you don't supply a value for this parameter, you'll receive a warning message stating that users granted this policy will not be able to make outbound PSTN calls.
Force	Optional	SwitchParameter	Suppresses any confirmation prompts that would otherwise be displayed before making changes.
InMemory	Optional	SwitchParameter	Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet.
WhatIf	Optional	SwitchParameter	Describes what would happen if you executed the command without actually executing the command.
Confirm	Optional	SwitchParameter	Prompts you for confirmation before executing the command.

Input Types

None.

Return Types

This cmdlet creates an instance of the Microsoft.Rtc.Management.WritableConfig.Voice.VoicePolicy object.

Example

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

New-CsVoicePolicy -Identity UserVoicePolicy1

This example creates a new per-user voice policy with default settings that has an Identity of UserVoicePolicy1.

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

New-CsVoicePolicy UserVoicePolicy2 -AllowSimulRing $false -PstnUsages @{add = "Local"}

This example creates a new per-user voice policy with an Identity of UserVoicePolicy2 and sets the AllowSimulRing property to False, meaning that any users to which this policy is assigned 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 adds "Local" to the list of PSTN usages, which associates this voice policy with a voice route that also uses the Local PSTN usage. (Note that the Identity parameter is not explicitly specified. The Identity parameter is a positional parameter and 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.)

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

$a = Get-CsPstnUsage
New-CsVoicePolicy site:Redmond -PstnUsages @{add = $a.Usage}

This example creates a new voice policy for site Redmond and applies all the PSTN usages defined for the organization 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 it in the variable $a. The second line calls New-CsVoicePolicy to create the new voice policy for site Redmond. A value is passed to the PstnUsages parameter to add the list contained in the global set of PSTN usages to this policy. Note the syntax of the add value: $a.Usage. This refers to the Usage property of the PSTN usage settings, which contains the list of PSTN usages.

Share via