See Also
Topic Last Modified: 2013-02-21
Modifies an existing dial plan. This cmdlet was introduced in Lync Server 2010.
Syntax
Set-CsDialPlan [-Identity <XdsIdentity>] <COMMON
PARAMETERS>
|
Set-CsDialPlan [-Instance <PSObject>] <COMMON
PARAMETERS>
|
COMMON PARAMETERS: [-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>]]
|
Examples
EXAMPLE 1
In Example 1, the Set-CsDialPlan cmdlet 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.
 Copy Code |
|
|---|---|
Set-CsDialPlan -Identity RedmondDialPlan -Description "This plan is for Redmond-based users only." |
|
EXAMPLE 2
In this example, the Set-CsDialPlan cmdlet 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 the Get-CsDialPlan cmdlet to return a collection of all the dial plans in the organization. That collection is then piped to the Set-CsDialPlan cmdlet, which assigns the value 8 to the ExternalAccessPrefix property for each profile in the collection.
| Copy Code |
|
|---|---|
Get-CsDialPlan | Set-CsDialPlan -ExternalAccessPrefix 8 |
|
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 cmdlet, theSet-CsVoiceNormalizationRule cmdlet, or the Remove-CsVoiceNormalizationRule cmdlet 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"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
City |
Optional |
System.String |
This parameter is not used with this cmdlet. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
|
CountryCode |
Optional |
System.String |
This parameter is not used with this cmdlet. |
|
Description |
Optional |
System.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 |
System.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 |
System.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. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses any confirmation prompts before making changes. |
|
Identity |
Optional |
Microsoft.Rtc.Management.Xds.XdsIdentity |
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. |
|
NormalizationRules |
Optional |
System.Management.Automation.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 |
System.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 |
System.String |
A friendly name for the dial plan. Dial plan names must be unique among all dial plans within a Lync Server 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 |
System.String |
This parameter is not used with this cmdlet. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object. Accepts pipelined input of dial plan objects.
Return Types
The Set-CsDialPlan cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object.
