Syntax


`Set-CsDialPlan [-Identity <XdsIdentity>] [-City <String>] [-Confirm [<SwitchParameter>]] [-CountryCode <String>] [-Description <String>] [-DialinConferencingRegion <String>] [-ExternalAccessPrefix <String>] [-Force <SwitchParameter>] [-NormalizationRules <PSListModifier>] [-OptimizeDeviceDialing <$true \| $false>] [-SimpleName <String>] [-State <String>] [-WhatIf [<SwitchParameter>]]`


`Set-CsDialPlan [-City <String>] [-Confirm [<SwitchParameter>]] [-CountryCode <String>] [-Description <String>] [-DialinConferencingRegion <String>] [-ExternalAccessPrefix <String>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-NormalizationRules <PSListModifier>] [-OptimizeDeviceDialing <$true \| $false>] [-SimpleName <String>] [-State <String>] [-WhatIf [<SwitchParameter>]]`

Parameters

Parameter	Required	Type	Description
Identity	Optional	String	The unique identifier designating the scope, or, for per-user plans, a name, to identify the dial plan you want to modify. For example, a site Identity will be in the format site:<sitename>, where sitename is the name of the site. A dial plan at the service scope will be a Registrar or PSTN gateway service, where the Identity value is formatted like this: Registrar:Redmond.litwareinc.com. A per-user Identity will be a unique string value.
Instance	Optional	LocationProfile	Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. You can retrieve this object reference by calling the Get-CsDialPlan cmdlet.
Description	Optional	String	A description of this dial plan--what it’s for, what type of user it applies to, or any other information that will be helpful in identifying the purpose of the dial plan. Maximum characters: 512
DialinConferencingRegion	Optional	String	The name of the region associated with this dial plan. Specify a value for this parameter if the dial plan will be used for dial-in conferencing. This allows the correct access number to be assigned when the conference organizer sets up the conference. Available regions can be retrieved by calling the Get-CsNetworkRegion cmdlet. Maximum characters: 512
ExternalAccessPrefix	Optional	String	A number (or set of numbers) that designates the call as external to the organization. (For example, to dial an outside line, first press 9.) This prefix will be ignored by the normalization rules, although these rules will be applied to the rest of the number. The OptimizeDeviceDialing parameter must be set to True for this value to take effect. The value of this parameter must match the regular expression [0-9]{1,4}. This means it must be a value one to four digits in length, each digit being a number 0 through 9.
NormalizationRules	Optional	PSListModifier	A list of normalization rules that are applied to this dial plan. While this list and these rules can be modified directly with this cmdlet, it is recommended that you create normalization rules with the New-CsVoiceNormalizationRule cmdlet, which creates the rule and assigns it to the specified dial plan, and modify them with the Set-CsVoiceNormalizationRule cmdlet.
OptimizeDeviceDialing	Optional	Boolean	Setting this parameter to True will apply the prefix in the ExternalAccessPrefix parameter to calls made outside the organization. This value can be set to True only if a value has been specified for the ExternalAccessPrefix parameter.
SimpleName	Optional	String	A friendly name for the dial plan. Dial plan names must be unique among all dial plans within a Microsoft Lync Server 2010 deployment. This string can be up to 256 characters long. Valid characters are alphabetic or numeric characters, hyphen (-), dot (.), plus (+), underscore (_), and parentheses (()).
State	Optional	String	This parameter is not used with this cmdlet.
City	Optional	String	This parameter is not used with this cmdlet.
CountryCode	Optional	String	This parameter is not used with this cmdlet.
Force	Optional	SwitchParameter	Suppresses any confirmation prompts before making changes.
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.

Detailed Description

This cmdlet modifies an existing dial plan (also known as a location profile). Dial plans provide information required to enable Enterprise Voice users to make telephone calls. Dial plans are also used by the Conferencing Attendant application for dial-in conferencing. A dial plan determines such things as which normalization rules are applied and whether a prefix must be dialed for external calls.

Note: While normalization rules of a dial plan can be modified with this cmdlet, it is recommended that the New-CsVoiceNormalizationRule, Set-CsVoiceNormalizationRule, or Remove-CsVoiceNormalizationRule cmdlets be used instead. The changes made with those cmdlets will be reflected in the corresponding dial plan.

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

Input Types

Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object. Accepts pipelined input of dial plan objects.

Return Types

Set-CsDialPlan does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object.

Example

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

	Copy Code
Set-CsDialPlan -Identity RedmondDialPlan -Description "This plan is for Redmond-based users only."

In Example 1, Set-CsDialPlan is used to modify the dial plan with the Identity RedmondDialPlan. In this case, the only property being modified is the Description; this modification is performed by specifying the Description parameter followed by the text for the new description.

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

	Copy Code
Get-CsDialPlan \| Set-CsDialPlan -ExternalAccessPrefix 8

In this example, Set-CsDialPlan is used to change the value of the ExternalAccessPrefix property for all the dial plans configured for use in the organization. To do this, the command first uses Get-CsDialPlan to return a collection of all the dial plans in the organization. That collection is then piped to Set-CsDialPlan, which assigns the value 8 to the ExternalAccessPrefix property for each profile in the collection.