Applies to: Exchange Server 2013

Topic Last Modified: 2012-07-02

Use the New-UMDialplan cmdlet to create a Unified Messaging (UM) dial plan to establish a link between UM IP gateways, UM hunt groups, and Mailbox servers to enable communication between Unified Messaging components.

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

Syntax


New-UMDialPlan -CountryOrRegionCode <String> -Name <String> -NumberOfDigitsInExtension <Int32> [-AccessTelephoneNumbers <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-DefaultLanguage <UMLanguage>] [-DefaultOutboundCallingLineId <String>] [-DomainController <Fqdn>] [-FaxEnabled <$true \| $false>] [-GenerateUMMailboxPolicy <$true \| $false>] [-GlobalCallRoutingScheme <None \| E164 \| GatewayGuid \| Reserved1 \| Reserved2 \| Reserved3>] [-Organization <OrganizationIdParameter>] [-SipResourceIdentifierRequired <$true \| $false>] [-SubscriberType <Enterprise \| Consumer>] [-URIType <TelExtn \| E164 \| SipName>] [-VoIPSecurity <SIPSecured \| Unsecured \| Secured>] [-WhatIf [<SwitchParameter>]]

New-UMDialPlan -CountryOrRegionCode <String> -Name
<String> -NumberOfDigitsInExtension <Int32>
[-AccessTelephoneNumbers <MultiValuedProperty>] [-Confirm
[<SwitchParameter>]] [-DefaultLanguage <UMLanguage>]
[-DefaultOutboundCallingLineId <String>] [-DomainController
<Fqdn>] [-FaxEnabled <$true | $false>]
[-GenerateUMMailboxPolicy <$true | $false>]
[-GlobalCallRoutingScheme <None | E164 | GatewayGuid | Reserved1
| Reserved2 | Reserved3>] [-Organization
<OrganizationIdParameter>] [-SipResourceIdentifierRequired
<$true | $false>] [-SubscriberType <Enterprise |
Consumer>] [-URIType <TelExtn | E164 | SipName>]
[-VoIPSecurity <SIPSecured | Unsecured | Secured>] [-WhatIf
[<SwitchParameter>]]

Examples

EXAMPLE 1

This example creates the UM dial plan MyUMDialPlan that uses four-digit extension numbers.

	Copy Code
New-UMDialplan -Name MyUMDialPlan -NumberOfDigitsInExtension 4

EXAMPLE 2

This example creates the UM dial plan MyUMDialPlan that uses five-digit extension numbers that support SIP URIs.

	Copy Code
New-UMDialplan -Name MyUMDialPlan -URIType SipName -NumberOfDigitsInExtension 5

EXAMPLE 3

This example creates the unsecured UM dial plan MyUMDialPlan that supports E.164 numbers and that uses five-digit extension numbers.

	Copy Code
New-UMDialplan -Name MyUMDialPlan -URIType E164 -NumberOfDigitsInExtension 5 -VoIPSecurity Unsecured

Detailed Description

The New-UMDialplan cmdlet creates a UM dial plan in Active Directory. A UM dial plan object has an organization-wide scope and contains all configuration information related to a telephony dial plan. A UM dial plan is a required component for establishing Unified Messaging communications with Microsoft Exchange Server 2013. When you create a UM dial plan, an understanding of telephony configurations and the implications of adding to or modifying a UM configuration is required.

Note:
After the new UM dial plan is created, a UM IP gateway and a Mailbox server must be associated with the UM dial plan to enable Unified Messaging operations.

After this task is completed, a new UM dial plan is created.

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.

Parameters

Parameter	Required	Type	Description
CountryOrRegionCode	Required	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.
Name	Required	System.String	The Name parameter specifies the display name of the UM dial plan. This description is presented to the administrator when a user is enabled for Unified Messaging. The UM dial plan name field can contain as many as 64 characters.
NumberOfDigitsInExtension	Required	System.Int32	The NumberOfDigitsInExtension parameter specifies the fixed number of digits in an extension number. The range for this parameter is from 1 through 20 digits.
AccessTelephoneNumbers	Optional	Microsoft.Exchange.Data.MultiValuedProperty	The AccessTelephoneNumbers parameter specifies the telephone number or numbers used for subscriber access. These numbers are sometimes referred to as pilot or pilot ID numbers. The telephone number is limited to 32 characters.
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.
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. If there are no other UM language packs installed, the default value is en-US.
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.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
FaxEnabled	Optional	System.Boolean	The FaxEnabled parameter specifies whether the Mailbox servers associated with the dial plan answer and process incoming fax calls. The default is `$true`.
GenerateUMMailboxPolicy	Optional	System.Boolean	The GenerateUMMailboxPolicy parameter specifies whether a default UM mailbox policy is created when the UM dial plan is created. The default setting is to create a UM mailbox when the UM dial plan is created.
GlobalCallRoutingScheme	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.UMGlobalCallRoutingScheme	The GlobalCallRoutingScheme parameter specifies whether UM-enabled users and auto attendant numbers should be included in the global routing database. If the setting is `E164`, the numbers are provisioned in the global routing database.
Organization	Optional	Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter	The Organization parameter is reserved for internal Microsoft use.
SipResourceIdentifierRequired	Optional	System.Boolean	The SipResourceIdentifierRequired parameter specifies whether the Session Initiation Protocol (SIP) resource identifier is required to be specified when mailboxes are UM-enabled and associated with the dial plan. The default is `$false` but it can only be set to `$true` if the Uniform Resource Identifier (URI) type of the dial plan is E.164.
SubscriberType	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.UMSubscriberType	The SubscriberType parameter specifies either `Consumer` or `Enterprise` as the type of dial plan. Enterprise dial plans are most likely to be used in a single organization. Consumer dial plans are used in hosted environments and can represent dial plans that may belong to different tenants.
URIType	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.UMUriType	The URIType parameter specifies the URI type to be sent and received with SIP messages from the Private Branch eXchange (PBX).
VoIPSecurity	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.UMVoIPSecurityType	The VoIPSecurity parameter specifies whether the signaling channel is encrypted using mutual Transport Layer Security (TLS). The default setting is `Unsecured`.
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.

Input Types

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.

Return Types

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.