New-UMDialplan

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

The New-UMDialplan cmdlet creates a new Unified Messaging (UM) dial plan that is used to establish a link between UM IP gateways, UM hunt groups, and Unified Messaging servers to enable communication between UM components.

Syntax

New-UMDialPlan -Name <String> -NumberOfDigitsInExtension <Int32> [-AccessTelephoneNumbers <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-FaxEnabled <$true | $false>] [-GenerateUMMailboxPolicy <$true | $false>] [-NDREnabled <$true | $false>] [-TemplateInstance <PSObject>] [-URIType <TelExtn | E164 | SipName>] [-VoIPSecurity <SIPSecured | Unsecured | Secured>] [-WhatIf [<SwitchParameter>]]

Detailed Description

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

Note

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

To run the New-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 Exchange, see Permission Considerations.

Parameters

Parameter Required Type Description

Name

Required

System.String

This 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

This parameter specifies the fixed number of digits in an extension number. The range for this parameter is 1 to 20 digits.

AccessTelephoneNumbers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the telephone number or numbers that will be 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

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.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter specifies the fully qualified domain name of the domain controller that writes this configuration change to Active Directory.

FaxEnabled

Optional

System.Boolean

This parameter specifies whether the users who are associated with the UM dial plan can receive fax messages. The default setting is $true.

GenerateUMMailboxPolicy

Optional

System.Boolean

This parameter specifies whether a default UM mailbox policy will be created when the UM dial plan is created. The default setting is to create a UM mailbox when the UM dial plan is created.

NDREnabled

Optional

System.Boolean

This parameter specifies whether UM call answering messages that are submitted will request non-delivery notifications. The default setting is $false.

TemplateInstance

Optional

System.Management.Automation.PSObject

This parameter specifies that the cmdlet will use the configuration of an existing object, when that object is supplied to this parameter, to create an identical copy of the object on a local or target server.

UriType

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMUriType

This parameter specifies the integer that represents the Uniform Resource Identifier (URI) type to be sent and received with Session Initiation Protocol (SIP) messages from the Private Branch eXchange (PBX).

VoIPSecurity

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMVoIPSecurityType

This parameter specifies whether the signaling channel is encrypted using Mutual Transport Layer Security (MTLS). The default setting is UnSecured.

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.

Input Types

Return Types

Errors

Error Description

 

 

Exceptions

Exceptions Description

 

 

Example

The first example creates a new UM dial plan named MyUMDialPlan that uses four-digit extension numbers.

The second example creates a new UM dial plan named MyUMDialPlan that uses five-digit extension numbers that support SIP URIs.

The third example creates a new unsecured UM dial plan named MyUMDialPlan that supports E164 numbers.

New-UMDialplan -Name MyUMDialPlan -NumberofDigits 4

New-UMDialplan -Name MyUMDialPlan -UriType SIPName -NumberofDigits 5

New-UMDialplan -Name MyUMDialPlan -UriType E164 -NumberofDigits 5 -VOIPSecurity Unsecured