Applies to: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2009-05-13

The Set-UMDialplan cmdlet can be used to set various properties on a Unified Messaging (UM) dial plan.

Syntax


Set-UMDialPlan -Identity <UMDialPlanIdParameter> [-AccessTelephoneNumbers <MultiValuedProperty>] [-AllowDialPlanSubscribers <$true \| $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true \| $false>] [-AudioCodec <G711 \| Wma \| Gsm>] [-AutomaticSpeechRecognitionEnabled <$true \| $false>] [-CallSomeoneEnabled <$true \| $false>] [-ConfiguredInCountryOrRegionGroups <MultiValuedProperty>] [-ConfiguredInternationalGroups <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-ContactAddressList <AddressListIdParameter>] [-ContactRecipientContainer <OrganizationalUnitIdParameter>] [-ContactScope <DialPlan \| GlobalAddressList \| Extension \| AutoAttendantLink \| AddressList>] [-CountryOrRegionCode <String>] [-DefaultLanguage <UMLanguage>] [-DialByNamePrimary <LastFirst \| FirstLast \| SMTPAddress>] [-DialByNameSecondary <LastFirst \| FirstLast \| SMTPAddress \| None>] [-DomainController <Fqdn>] [-EquivalenceDialPlan <Guid>] [-Extension <String>] [-FaxEnabled <$true \| $false>] [-FDSPollingInterval <Int32>] [-InCountryOrRegionNumberFormat <NumberFormat>] [-InfoAnnouncementEnabled <True \| False \| Uninteruptible>] [-InfoAnnouncementFilename <String>] [-InputFailuresBeforeDisconnect <Int32>] [-InputRetries <Int32>] [-InputTimeout <Int32>] [-InternationalAccessCode <String>] [-InternationalNumberFormat <NumberFormat>] [-LogonFailuresBeforeDisconnect <Int32>] [-MatchedNameSelectionMethod <Title \| Department \| Location \| None \| PromptForAlias>] [-MaxCallDuration <Int32>] [-MaxRecordingDuration <Int32>] [-Name <String>] [-NationalNumberPrefix <String>] [-NDREnabled <$true \| $false>] [-OperatorExtension <String>] [-OutsideLineAccessCode <String>] [-PromptPublishingPoint <String>] [-RecordingIdleTimeout <Int32>] [-SendVoiceMsgEnabled <$true \| $false>] [-TUIPromptEditingEnabled <$true \| $false>] [-UMAutoAttendant <UMAutoAttendantIdParameter>] [-VoIPSecurity <SIPSecured \| Unsecured \| Secured>] [-WelcomeGreetingEnabled <$true \| $false>] [-WelcomeGreetingFilename <String>] [-WhatIf [<SwitchParameter>]]

Set-UMDialPlan -Identity <UMDialPlanIdParameter>
[-AccessTelephoneNumbers <MultiValuedProperty>]
[-AllowDialPlanSubscribers <$true | $false>]
[-AllowedInCountryOrRegionGroups <MultiValuedProperty>]
[-AllowedInternationalGroups <MultiValuedProperty>]
[-AllowExtensions <$true | $false>] [-AudioCodec <G711 |
Wma | Gsm>] [-AutomaticSpeechRecognitionEnabled <$true |
$false>] [-CallSomeoneEnabled <$true | $false>]
[-ConfiguredInCountryOrRegionGroups <MultiValuedProperty>]
[-ConfiguredInternationalGroups <MultiValuedProperty>]
[-Confirm [<SwitchParameter>]] [-ContactAddressList
<AddressListIdParameter>] [-ContactRecipientContainer
<OrganizationalUnitIdParameter>] [-ContactScope <DialPlan
| GlobalAddressList | Extension | AutoAttendantLink |
AddressList>] [-CountryOrRegionCode <String>]
[-DefaultLanguage <UMLanguage>] [-DialByNamePrimary
<LastFirst | FirstLast | SMTPAddress>] [-DialByNameSecondary
<LastFirst | FirstLast | SMTPAddress | None>]
[-DomainController <Fqdn>] [-EquivalenceDialPlan
<Guid>] [-Extension <String>] [-FaxEnabled <$true |
$false>] [-FDSPollingInterval <Int32>]
[-InCountryOrRegionNumberFormat <NumberFormat>]
[-InfoAnnouncementEnabled <True | False | Uninteruptible>]
[-InfoAnnouncementFilename <String>]
[-InputFailuresBeforeDisconnect <Int32>] [-InputRetries
<Int32>] [-InputTimeout <Int32>]
[-InternationalAccessCode <String>]
[-InternationalNumberFormat <NumberFormat>]
[-LogonFailuresBeforeDisconnect <Int32>]
[-MatchedNameSelectionMethod <Title | Department | Location |
None | PromptForAlias>] [-MaxCallDuration <Int32>]
[-MaxRecordingDuration <Int32>] [-Name <String>]
[-NationalNumberPrefix <String>] [-NDREnabled <$true |
$false>] [-OperatorExtension <String>]
[-OutsideLineAccessCode <String>] [-PromptPublishingPoint
<String>] [-RecordingIdleTimeout <Int32>]
[-SendVoiceMsgEnabled <$true | $false>]
[-TUIPromptEditingEnabled <$true | $false>] [-UMAutoAttendant
<UMAutoAttendantIdParameter>] [-VoIPSecurity <SIPSecured |
Unsecured | Secured>] [-WelcomeGreetingEnabled <$true |
$false>] [-WelcomeGreetingFilename <String>] [-WhatIf
[<SwitchParameter>]]


Set-UMDialPlan [-AccessTelephoneNumbers <MultiValuedProperty>] [-AllowDialPlanSubscribers <$true \| $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true \| $false>] [-AudioCodec <G711 \| Wma \| Gsm>] [-AutomaticSpeechRecognitionEnabled <$true \| $false>] [-CallSomeoneEnabled <$true \| $false>] [-ConfiguredInCountryOrRegionGroups <MultiValuedProperty>] [-ConfiguredInternationalGroups <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-ContactAddressList <AddressListIdParameter>] [-ContactRecipientContainer <OrganizationalUnitIdParameter>] [-ContactScope <DialPlan \| GlobalAddressList \| Extension \| AutoAttendantLink \| AddressList>] [-CountryOrRegionCode <String>] [-DefaultLanguage <UMLanguage>] [-DialByNamePrimary <LastFirst \| FirstLast \| SMTPAddress>] [-DialByNameSecondary <LastFirst \| FirstLast \| SMTPAddress \| None>] [-DomainController <Fqdn>] [-EquivalenceDialPlan <Guid>] [-Extension <String>] [-FaxEnabled <$true \| $false>] [-FDSPollingInterval <Int32>] [-InCountryOrRegionNumberFormat <NumberFormat>] [-InfoAnnouncementEnabled <True \| False \| Uninteruptible>] [-InfoAnnouncementFilename <String>] [-InputFailuresBeforeDisconnect <Int32>] [-InputRetries <Int32>] [-InputTimeout <Int32>] [-Instance <UMDialPlan>] [-InternationalAccessCode <String>] [-InternationalNumberFormat <NumberFormat>] [-LogonFailuresBeforeDisconnect <Int32>] [-MatchedNameSelectionMethod <Title \| Department \| Location \| None \| PromptForAlias>] [-MaxCallDuration <Int32>] [-MaxRecordingDuration <Int32>] [-Name <String>] [-NationalNumberPrefix <String>] [-NDREnabled <$true \| $false>] [-OperatorExtension <String>] [-OutsideLineAccessCode <String>] [-PromptPublishingPoint <String>] [-RecordingIdleTimeout <Int32>] [-SendVoiceMsgEnabled <$true \| $false>] [-TUIPromptEditingEnabled <$true \| $false>] [-UMAutoAttendant <UMAutoAttendantIdParameter>] [-VoIPSecurity <SIPSecured \| Unsecured \| Secured>] [-WelcomeGreetingEnabled <$true \| $false>] [-WelcomeGreetingFilename <String>] [-WhatIf [<SwitchParameter>]]

Set-UMDialPlan [-AccessTelephoneNumbers
<MultiValuedProperty>] [-AllowDialPlanSubscribers <$true |
$false>] [-AllowedInCountryOrRegionGroups
<MultiValuedProperty>] [-AllowedInternationalGroups
<MultiValuedProperty>] [-AllowExtensions <$true |
$false>] [-AudioCodec <G711 | Wma | Gsm>]
[-AutomaticSpeechRecognitionEnabled <$true | $false>]
[-CallSomeoneEnabled <$true | $false>]
[-ConfiguredInCountryOrRegionGroups <MultiValuedProperty>]
[-ConfiguredInternationalGroups <MultiValuedProperty>]
[-Confirm [<SwitchParameter>]] [-ContactAddressList
<AddressListIdParameter>] [-ContactRecipientContainer
<OrganizationalUnitIdParameter>] [-ContactScope <DialPlan
| GlobalAddressList | Extension | AutoAttendantLink |
AddressList>] [-CountryOrRegionCode <String>]
[-DefaultLanguage <UMLanguage>] [-DialByNamePrimary
<LastFirst | FirstLast | SMTPAddress>] [-DialByNameSecondary
<LastFirst | FirstLast | SMTPAddress | None>]
[-DomainController <Fqdn>] [-EquivalenceDialPlan
<Guid>] [-Extension <String>] [-FaxEnabled <$true |
$false>] [-FDSPollingInterval <Int32>]
[-InCountryOrRegionNumberFormat <NumberFormat>]
[-InfoAnnouncementEnabled <True | False | Uninteruptible>]
[-InfoAnnouncementFilename <String>]
[-InputFailuresBeforeDisconnect <Int32>] [-InputRetries
<Int32>] [-InputTimeout <Int32>] [-Instance
<UMDialPlan>] [-InternationalAccessCode <String>]
[-InternationalNumberFormat <NumberFormat>]
[-LogonFailuresBeforeDisconnect <Int32>]
[-MatchedNameSelectionMethod <Title | Department | Location |
None | PromptForAlias>] [-MaxCallDuration <Int32>]
[-MaxRecordingDuration <Int32>] [-Name <String>]
[-NationalNumberPrefix <String>] [-NDREnabled <$true |
$false>] [-OperatorExtension <String>]
[-OutsideLineAccessCode <String>] [-PromptPublishingPoint
<String>] [-RecordingIdleTimeout <Int32>]
[-SendVoiceMsgEnabled <$true | $false>]
[-TUIPromptEditingEnabled <$true | $false>] [-UMAutoAttendant
<UMAutoAttendantIdParameter>] [-VoIPSecurity <SIPSecured |
Unsecured | Secured>] [-WelcomeGreetingEnabled <$true |
$false>] [-WelcomeGreetingFilename <String>] [-WhatIf
[<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter	This parameter specifies the UM dial plan ID. This parameter is the directory object identifier for the UM dial plan. This parameter is used to link mailboxes to dial plans and Unified Messaging servers to dial plans.
AccessTelephoneNumbers	Optional	Microsoft.Exchange.Data.MultiValuedProperty	This parameter specifies a single valid voice mail pilot number or a list of valid voice mail pilot numbers. This list is presented to the administrator when a user is being enabled for Unified Messaging.
AllowDialPlanSubscribers	Optional	System.Boolean	This parameter specifies whether to let subscribers dial numbers that resolve to a subscriber within the same dial plan. The default is `$true`.
AllowedInCountryOrRegionGroups	Optional	Microsoft.Exchange.Data.MultiValuedProperty	This parameter specifies the list of in-country/region names from the same dial group that can be dialed. The name of the allowed in-country/region group must match the group name that is specified in the UM dial plan.
AllowedInternationalGroups	Optional	Microsoft.Exchange.Data.MultiValuedProperty	This parameter specifies the list of international dial group names that are allowed. The international dial group name must match the group name that is specified in the dial plan.
AllowExtensions	Optional	System.Boolean	This parameter specifies whether to allow calls to dial plan extensions. The default is `$false`.
AudioCodec	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.AudioCodecEnum	This parameter specifies the audio codec that is used for recording. WMA is the default setting.
AutomaticSpeechRecognitionEnabled	Optional	System.Boolean	This parameter specifies whether speech recognition is enabled for users who are members of the dial plan.
CallSomeoneEnabled	Optional	System.Boolean	This parameter specifies whether the Call Someone feature is enabled.
ConfiguredInCountryOrRegionGroups	Optional	Microsoft.Exchange.Data.MultiValuedProperty	This parameter specifies the in-country groups that can be used. Each string consists of four parts: A group name (up to 32 characters) AllowedNumberString DialNumberString TextComment
ConfiguredInternationalGroups	Optional	Microsoft.Exchange.Data.MultiValuedProperty	This parameter specifies the international groups that can be used. Each string consists of four parts: A group name (up to 32 characters) AllowedNumberString DialNumberString TextComment
Confirm	Optional	System.Management.Automation.SwitchParameter	This parameter causes the command to pause processing and requires the administrator to acknowledge what the command will do before processing continues. The default value is $true.
ContactAddressList	Optional	Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter	This parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, it will define the scope for directory searches.
ContactRecipientContainer	Optional	Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter	This is the name or identity of the container that will be used for directory searches.
ContactScope	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.CallSomeoneScopeEnum	This parameter specifies the scope of the directory search that will be given to callers when they access the UM dial plan and specify a user's name
CountryOrRegionCode	Optional	System.String	This parameter specifies the country or region code for a given country or region. This is the number that will be dialed for a specific country or region. For example, 1 in the United States.
DefaultLanguage	Optional	Microsoft.Exchange.Data.UMLanguage	This parameter specifies the default language of the system. This default language is selected from the list of available languages. The default is US English.
DialByNamePrimary	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.DialByNamePrimaryEnum	This parameter specifies that the Dial by Name lookup key is to be created from the specified source. The default is Last, First name.
DialByNameSecondary	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.DialByNameSecondaryEnum	This parameter specifies that the secondary Dial by Name lookup key is to be created from the specified source. The default is Simple Mail Transfer Protocol (SMTP).
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	This parameter specifies the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service.
EquivalenceDialPlan	Optional	System.Guid	This parameter specifies the name of the equivalency dial plan in another forest. When a telephony dial plan spans two forests and when a second dial plan object is created, the GUID from the original dial plan is copied to the user's proxy address in the other forest.
Extension	Optional	System.String	This parameter specifies the extension number that is used by the Call Someone feature when a call is transferred.
FaxEnabled	Optional	System.Boolean	This parameter specifies whether the system supports faxing. The Unified Messaging server will not load the fax components if the dial plan does not support faxing. The default is `$true`.
FDSPollingInterval	Optional	System.Int32	The interval, in minutes, between checks for new content made by the File Distribution Service on the publishing point. The range is from 1 to 1,440 minutes. The default is 5 minutes.
InCountryOrRegionNumberFormat	Optional	Microsoft.Exchange.Data.NumberFormat	This parameter specifies the prefix string to use and the number of digits to take from the directory. This number is used when dialing into this dial plan from inside the same country or region code.
InfoAnnouncementEnabled	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.InfoAnnouncementEnabledEnum	This parameter specifies whether an informational announcement is enabled. This parameter can be set to Enabled, Disabled, or Uninterruptible. The default is `$true`.
InfoAnnouncementFilename	Optional	System.String	This parameter specifies the audio file name for an informational announcement.
InputFailuresBeforeDisconnect	Optional	System.Int32	This parameter specifies the number of sequential user input errors that will be allowed before the call is disconnected. The default is 3.
InputRetries	Optional	System.Int32	This parameter specifies the number of times a caller can re-enter input when the system times out. This applies to authenticated users and also call answering or auto attendant users. The default is 3.
InputTimeout	Optional	System.Int32	This parameter specifies the length of time that the system will wait for user input. This time limit applies to authenticated users and also call answering or auto attendant users. The default is 5 seconds.
Instance	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.UMDialPlan	This parameter specifies the input parameter that represents a new dial plan object.
InternationalAccessCode	Optional	System.String	This parameter specifies the code that is pre-appended to a telephone number to dial international calls. For example, 011 to call the United States.
InternationalNumberFormat	Optional	Microsoft.Exchange.Data.NumberFormat	This parameter specifies the prefix string to use, and the number of digits to take from the directory, when dialing into this dial plan from a different country code.
LogonFailuresBeforeDisconnect	Optional	System.Int32	This parameter specifies the number of sequential unsuccessful logon attempts that can be made before the call is disconnected. The default is 3.
MatchedNameSelectionMethod	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.DisambiguationFieldEnum	This parameter specifies the selection to use to differentiate between users who have names that match the touchtone or speech input. This setting can be set to the following: Department Title Location None Prompt for alias Inherited from UM dial plan
MaxCallDuration	Optional	System.Int32	This parameter specifies the maximum length of time that a call can last before it is interrupted and the call is dropped. The default is 30 minutes.
MaxRecordingDuration	Optional	System.Int32	This parameter specifies the maximum length of time that messages can be recorded. This includes all kinds of calls. This value can be set from 5 through 100. Setting this value too low can cause long voice messages to be disconnected before they are completed. Setting this value too high lets users save lengthy voice messages in their Inboxes. For Exchange 2007 Service Pack 2 (SP2), the value of this setting can be from 1 through 100.
Name	Optional	System.String	This parameter specifies the display name to use for the UM dial plan. This name is limited to 64 characters.
NationalNumberPrefix	Optional	System.String	This parameter specifies the code that is pre-appended to a telephone number to dial out-of-area, in-country calls. For example, 1 in North America.
NDREnabled	Optional	System.Boolean	This parameter specifies whether UM call answering messages that are submitted will request non-delivery reports (NDRs). If this parameter is set to `$false`, messages will be submitted without requests for NDRs. The default is `$false`.
OperatorExtension	Optional	System.String	This parameter specifies the extension number of the operator. If this parameter is not specified, the Do Not Allow Transfer to the Operator feature will be unavailable.
OutsideLineAccessCode	Optional	System.String	This parameter specifies the code that is pre-appended to a telephone number to dial an external in-country telephone number. This code is also referred to as a trunk access code. The default is 9.
PromptPublishingPoint	Optional	System.String	This parameter specifies the Microsoft Windows file shares path of the server and share where custom prompts will reside. The default path is set to the first Unified Messaging server when it is added to a UM dial plan.
RecordingIdleTimeout	Optional	System.Int32	This parameter specifies the length of time that a caller can be silent when recording a voice message before the recording is ended. The default is 5 seconds.
SendVoiceMsgEnabled	Optional	System.Boolean	This parameter specifies whether the Send Message feature is enabled.
TUIPromptEditingEnabled	Optional	System.Boolean	This parameter specifies whether authorized users are permitted to record UM dial plan or automated attendant prompts by using the telephone user interface (TUI). The default setting is `$false`.
UMAutoAttendant	Optional	Microsoft.Exchange.Configuration.Tasks.UMAutoAttendantIdParameter	This parameter specifies the auto attendant that is executed when the caller presses the star key (*). If this parameter is specified, it will override the Call Someone feature.
VoIPSecurity	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.UMVoIPSecurityType	This parameter specifies whether the Voice over IP (VoIP) traffic is not encrypted or that the signaling channel or the signaling and the media channels are encrypted by using Mutual Transport Layer Security (MTLS). The default setting is `UnSecured`.
WelcomeGreetingEnabled	Optional	System.Boolean	This parameter specifies whether a custom Welcome greeting is enabled. The default is `$false`.
WelcomeGreetingFilename	Optional	System.String	This parameter specifies the audio file name for the welcome greeting.
WhatIf	Optional	System.Management.Automation.SwitchParameter	This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, the administrator can view what changes would occur without having to apply any of those changes. The default value is $true.

Detailed Description

The Set-UMDialplan cmdlet lets you change or modify the properties of an existing UM dial plan. Some UM dial plan properties are required and are created by default. However, in some cases, after the UM dial plan is created, not all properties for the UM dial plan are writable. Therefore, some of the properties cannot be changed unless the existing UM dial plan is deleted and a new one is created.

Important:
UM dial plans are important to the operation of Unified Messaging. Modifications to an existing UM dial plan should be performed by an administrator who understands the implications of changes to UM dial plans.

To run the Set-UMDialplan cmdlet, the account you use must be delegated the Exchange Organization Administrator role

For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.

Input Types

Return Types

Errors

Error	Description

Exceptions

Exceptions	Description

Example

The first example configures a UM dial plan named MyUMDialPlan to use 9 for the outside line access code.

The second example configures a UM dial plan named MyUMDialPlan to use a welcome greeting.

The third example configures a UM dial plan named MyUMDialPlan with dialing rules.

	Copy Code
Set-UMDialPlan -Identity MyDialPlan -OutsideLineAccessCode 9 Set-UMDialPlan -Identity MyDialPlan -WelcomeGreetingEnabled $true -WelcomeGreetingFilename welcome.wav $csv=import-csv "C:\MyInCountryGroups.csv" Set-UMDialPlan -Identity MyDialPlan -ConfiguredInCountryGroups $csv Set-UMDialPlan -Identity MyDialPlan -AllowedInCountryGroups "local, long distance"

Copy Code

Set-UMDialPlan -Identity MyDialPlan -OutsideLineAccessCode 9

Set-UMDialPlan -Identity MyDialPlan -WelcomeGreetingEnabled $true -WelcomeGreetingFilename welcome.wav

$csv=import-csv "C:\MyInCountryGroups.csv"
Set-UMDialPlan -Identity MyDialPlan -ConfiguredInCountryGroups $csv
Set-UMDialPlan -Identity MyDialPlan -AllowedInCountryGroups "local, long distance"