[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Modifies an existing dial plan.

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 [-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>]]

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.
Instance	Optional	PSObject	Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
City	Optional	String	The city served by this dial plan. This property is used for conferencing; it is not needed for Enterprise Voice.
Confirm	Optional	SwitchParameter	Prompts you for confirmation before executing the command.
CountryCode	Optional	String	The country code of the country served by this dial plan. This property is used for conferencing; it is not needed for Enterprise Voice.
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 charaters: 512
DialinConferencingRegion	Optional	String	The name of the region associated with this dial plan. 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. This prefix is applicable only to off-hook (from a phone, not from Communicator) dialing. The OptimizeDeviceDialing parameter must be set to True for this value to take effect. This parameter must match the regular expression [0-9]{1,4}. This means it must be a value 0 through 9, one to four digits in length.
SimpleName	Optional	String	A friendly name for the dial plan. Dial plan names must be unique among all dial plans within a Microsoft Communications 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 (()).
NormalizationRules	Optional	PSListModifier	A list of normalization rules that are applied to this dial plan. While this list and these rules can be created directly with this cmdlet, it is recommended that you create the normalization rules with the New-CsVoiceNormalizationRule cmdlet, which creates the rule and assigns it to the specified dial plan.
OptimizeDeviceDialing	Optional	Boolean	Determines whether normalization rules will be applied differently based on whether a call was made from Communicator or from an off-hook device (a phone). If True, the prefix in the ExternalAccessPrefix parameter will be applied to calls outside the organization.
State	Optional	String	The state or province served by this dial plan. This property is used for conferencing; it is not needed for Enterprise Voice.
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.

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 because the changes made with those cmdlets are reflected in the corresponding dial plan.

Return Types

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

Examples

-------------------------- 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 location profiles 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.