Export (0) Print
Expand All

Set-UMDialplan

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-15

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-UMDialplan cmdlet to set various properties on a Unified Messaging (UM) dial plan.

For information about the parameter sets in the Syntax section below, see Syntax.

Set-UMDialPlan -Identity <UMDialPlanIdParameter> [-AccessTelephoneNumbers <MultiValuedProperty>] [-AllowDialPlanSubscribers <$true | $false>] [-AllowedInCountryOrRegionGroups <MultiValuedProperty>] [-AllowedInternationalGroups <MultiValuedProperty>] [-AllowExtensions <$true | $false>] [-AllowHeuristicADCallingLineIdResolution <$true | $false>] [-AudioCodec <G711 | Wma | Gsm | Mp3>] [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-CallAnsweringRulesEnabled <$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>] [-DefaultOutboundCallingLineId <String>] [-DialByNamePrimary <LastFirst | FirstLast | SMTPAddress>] [-DialByNameSecondary <LastFirst | FirstLast | SMTPAddress | None>] [-DomainController <Fqdn>] [-EquivalentDialPlanPhoneContexts <MultiValuedProperty>] [-Extension <String>] [-FaxEnabled <$true | $false>] [-ForceUpgrade <SwitchParameter>] [-InCountryOrRegionNumberFormat <NumberFormat>] [-InfoAnnouncementEnabled <True | False | Uninterruptible>] [-InfoAnnouncementFilename <String>] [-InputFailuresBeforeDisconnect <Int32>] [-InternationalAccessCode <String>] [-InternationalNumberFormat <NumberFormat>] [-LegacyPromptPublishingPoint <String>] [-LogonFailuresBeforeDisconnect <Int32>] [-MatchedNameSelectionMethod <Title | Department | Location | None | PromptForAlias>] [-MaxCallDuration <Int32>] [-MaxRecordingDuration <Int32>] [-Name <String>] [-NationalNumberPrefix <String>] [-NumberingPlanFormats <MultiValuedProperty>] [-OperatorExtension <String>] [-OutsideLineAccessCode <String>] [-PilotIdentifierList <MultiValuedProperty>] [-RecordingIdleTimeout <Int32>] [-SendVoiceMsgEnabled <$true | $false>] [-TUIPromptEditingEnabled <$true | $false>] [-UMAutoAttendant <UMAutoAttendantIdParameter>] [-VoIPSecurity <SIPSecured | Unsecured | Secured>] [-WelcomeGreetingEnabled <$true | $false>] [-WelcomeGreetingFilename <String>] [-WhatIf [<SwitchParameter>]]

This example configures the UM dial plan MyDialPlan to use 9 for the outside line access code.

Set-UMDialplan -Identity MyDialPlan -OutsideLineAccessCode 9

This example configures the UM dial plan MyDialPlan to use a welcome greeting.

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

This example configures the UM dial plan MyDialPlan with dialing rules.

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

The Set-UMDialplan cmdlet changes or modifies 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 can't be changed unless the existing UM dial plan is deleted and a new one is created.

ImportantImportant:
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.

After this task is completed, the parameters and values specified are configured on the UM dial plan.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "UM dial plans" entry in the Unified Messaging permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

The Identity 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 and Mailbox and Client Access servers to dial plans.

AccessTelephoneNumbers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AccessTelephoneNumbers parameter specifies a single valid voice mail pilot number or a list of valid voice mail pilot numbers. This list is presented to you when a user is being enabled for Unified Messaging.

AllowDialPlanSubscribers

Optional

System.Boolean

The AllowDialPlanSubscribers parameter specifies whether to allow subscribers dial numbers that resolve to a subscriber within the same dial plan. The default value is $true.

AllowedInCountryOrRegionGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AllowedInCountryOrRegionGroups 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 specified in the UM dial plan.

AllowedInternationalGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AllowedInternationalGroups parameter specifies the list of international dial group names allowed. The international dial group name must match the group name specified in the dial plan.

AllowExtensions

Optional

System.Boolean

The AllowExtensions parameter specifies whether to allow calls to dial plan extensions. The default value is $false.

AllowHeuristicADCallingLineIdResolution

Optional

System.Boolean

The AllowHeuristicADCallingLineIdResolution parameter specifies whether to allow calling line ID resolution using telephone number fields that may be configured in Active Directory. When this parameter is set to $true, the telephone numbers such as those defined in the Mobile or Home telephone number fields in Active Directory are used. Setting this parameter to $true allows for resolution of calling IDs for both UM-enabled and non-UM-enabled users. The default is $true. You may want to set this parameter to $false if the telephone numbers for users aren't in a standard format. If the telephone numbers aren't in a standard format, the Mailbox server may not be able to correctly resolve the caller ID to a name of a user in a consistent manner.

AudioCodec

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.AudioCodecEnum

The AudioCodec parameter specifies the audio codec used for recording. Mp3 is the default setting.

AutomaticSpeechRecognitionEnabled

Optional

System.Boolean

The AutomaticSpeechRecognitionEnabled parameter specifies whether Automatic Speech Recognition (ASR) is enabled for users who are members of the dial plan.

CallAnsweringRulesEnabled

Optional

System.Boolean

The CallAnsweringRulesEnabled parameter specifies whether Call Answering Rules are enabled for UM-enabled users associated with the UM dial plan.

CallSomeoneEnabled

Optional

System.Boolean

The CallSomeoneEnabled parameter specifies whether the Call Someone feature is enabled.

ConfiguredInCountryOrRegionGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConfiguredInCountryOrRegionGroups parameter specifies the in-country groups that can be used. Each string consists of four parts:

  • Group name (up to 32 characters)

  • AllowedNumberString

  • DialNumberString

  • TextComment

ConfiguredInternationalGroups

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConfiguredInternationalGroups parameter specifies the international groups that can be used. Each string consists of four parts:

  • Group name (up to 32 characters)

  • AllowedNumberString

  • DialNumberString

  • TextComment

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

ContactAddressList

Optional

Microsoft.Exchange.Configuration.Tasks.AddressListIdParameter

The ContactAddressList parameter specifies the identity of the address list. If the ContactScope parameter is set to AddressList, this parameter defines the scope for directory searches.

ContactRecipientContainer

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

The ContactRecipientContainer parameter specifies the name or identity of the container used for directory searches.

ContactScope

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.CallSomeoneScopeEnum

The ContactScope parameter specifies the scope of the directory search provided to callers when they access the UM dial plan and specify a user's name.

CountryOrRegionCode

Optional

System.String

The CountryOrRegionCode parameter specifies the country or region code that precedes a telephone number used to place calls from other countries or regions to the country or region in which the UM dial plan is located. For example, 1 is the code used for North America, and 44 is the code used for the United Kingdom.

DefaultLanguage

Optional

Microsoft.Exchange.Data.UMLanguage

The DefaultLanguage parameter specifies the default language of the system. This default language is selected from the list of available languages. The default value is U.S. English.

DefaultOutboundCallingLineId

Optional

System.String

The DefaultOutboundCallingLineId parameter specifies the phone number that a Mailbox server would use as the calling line ID when placing an outbound call. By default, this is set to $null and only the extension number of the UM-enabled user that places the outbound call is used. This parameter is reserved for internal Microsoft use.

DialByNamePrimary

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DialByNamePrimaryEnum

The DialByNamePrimary parameter specifies that the Dial by Name lookup key is to be created from the specified source. The default value is LastFirst.

DialByNameSecondary

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DialByNameSecondaryEnum

The DialByNameSecondary parameter specifies that the secondary Dial by Name lookup key is to be created from the specified source. The default value is SMTPAddress.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

EquivalentDialPlanPhoneContexts

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The EquivalentDialPlanPhoneContexts parameter specifies the name of an equivalency dial plan. This parameter can be used when two UM dial plans exist but are in different forests or when a Private Branch eXchange (PBX) numbering plan spans two UM dial plans. Adding the name of the equivalency dial plan allows name lookups using a caller ID to search in the user's dial plan but then also search for a name for the calling line ID in any equivalent dial plans that are configured.

Extension

Optional

System.String

The Extension parameter specifies the extension number used by the Call Someone feature when a call is transferred.

FaxEnabled

Optional

System.Boolean

The FaxEnabled parameter specifies whether the Mailbox servers associated with the UM dial plan answers and processes incoming fax calls. The default value is $true.

ForceUpgrade

Optional

System.Management.Automation.SwitchParameter

The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM dial plan object is upgraded.

InCountryOrRegionNumberFormat

Optional

Microsoft.Exchange.Data.NumberFormat

The InCountryOrRegionNumberFormat 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

The InfoAnnouncementEnabled parameter specifies whether an informational announcement is enabled. This parameter can be set to True, False, or Uninterruptible. The default value is False.

InfoAnnouncementFilename

Optional

System.String

The InfoAnnouncementFilename parameter specifies the audio file name for an informational announcement.

InputFailuresBeforeDisconnect

Optional

System.Int32

The InputFailuresBeforeDisconnect parameter specifies the number of sequential user input errors allowed before the call is disconnected. The default value is 3.

InternationalAccessCode

Optional

System.String

The InternationalAccessCode parameter specifies the code that precedes a telephone number to dial international calls. For example, 011 is the code used to call the United States.

InternationalNumberFormat

Optional

Microsoft.Exchange.Data.NumberFormat

The InternationalNumberFormat 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.

LegacyPromptPublishingPoint

Optional

System.String

The LegacyPromptPublishingPoint parameter specifies the location of the prompt publishing point for Microsoft Exchange Server 2007 Unified Messaging servers. In coexistence scenarios, this parameter is used when Exchange 2007 and Exchange Server 2010 Unified Messaging servers are added to the same Exchange 2010 UM dial plan.

LogonFailuresBeforeDisconnect

Optional

System.Int32

The LogonFailuresBeforeDisconnect parameter specifies the number of sequential unsuccessful logon attempts that can be made before the call is disconnected. The default value is 3.

MatchedNameSelectionMethod

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DisambiguationFieldEnum

The MatchedNameSelectionMethod 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:

  • Title

  • Department

  • Location

  • None

  • PromptForAlias

MaxCallDuration

Optional

System.Int32

The MaxCallDuration parameter specifies the maximum length of time that a call can last before it's interrupted and the call is dropped. The default value is 30 minutes.

MaxRecordingDuration

Optional

System.Int32

The MaxRecordingDuration parameter specifies the maximum length of time that messages can be recorded. This includes all kinds of calls. The default is 20 minutes. The value of this setting can be from 1 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.

Name

Optional

System.String

The Name parameter specifies the display name to use for the UM dial plan. This name is limited to 64 characters.

NationalNumberPrefix

Optional

System.String

The NationalNumberPrefix parameter specifies the dialing code that precedes a telephone number when placing calls from one local area to another within a specific country or region. For example, 1 is the code used within North America, and 0 is the code used within the United Kingdom.

NumberingPlanFormats

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The NumberingPlanFormats parameter specifies one or more phone number masks that can be used for resolving caller ID to names of users in Active Directory.

OperatorExtension

Optional

System.String

The OperatorExtension parameter specifies the extension number of the operator. If this parameter isn't specified, the Do Not Allow Transfer to the Operator feature is unavailable.

OutsideLineAccessCode

Optional

System.String

The OutsideLineAccessCode parameter specifies the code that precedes a telephone number to dial an external in-country telephone number. This code is also referred to as a trunk access code. The default value is 9.

PilotIdentifierList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The PilotIdentifierList parameter specifies the pilot numbers configured on the dial plan. A single dial plan can have multiple pilot numbers. The pilot numbers must be in the E.164 format.

RecordingIdleTimeout

Optional

System.Int32

The RecordingIdleTimeout parameter specifies the length of time that a caller can be silent when recording a voice message before the recording is ended. The default value is 5 seconds.

SendVoiceMsgEnabled

Optional

System.Boolean

The SendVoiceMsgEnabled parameter specifies whether the Send Message feature is enabled.

TUIPromptEditingEnabled

Optional

System.Boolean

The TUIPromptEditingEnabled 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

The UMAutoAttendant parameter specifies the auto attendant run when the caller presses the star (*) key. If this parameter is specified, it overrides the Call Someone feature.

VoIPSecurity

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMVoIPSecurityType

This parameter is available only in on-premises Exchange 2013.

The VoIPSecurity parameter specifies whether the Voice over IP (VoIP) traffic is encrypted or that the signaling channel or the signaling and the media channels are encrypted by using mutual Transport Layer Security (TLS). The default setting is Unsecured.

WelcomeGreetingEnabled

Optional

System.Boolean

The WelcomeGreetingEnabled parameter specifies whether a custom welcome greeting is enabled. The default value is $false.

WelcomeGreetingFilename

Optional

System.String

The WelcomeGreetingFilename parameter specifies the audio file name for the welcome greeting.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft