Edit

Share via


Set-UMDialPlan

This cmdlet is available only in on-premises Exchange.

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 Exchange cmdlet syntax.

Syntax

Default (Default)

Set-UMDialPlan
    [-Identity] <UMDialPlanIdParameter>
    [-AccessTelephoneNumbers <MultiValuedProperty>]
    [-AllowDialPlanSubscribers <Boolean>]
    [-AllowedInCountryOrRegionGroups <MultiValuedProperty>]
    [-AllowedInternationalGroups <MultiValuedProperty>]
    [-AllowExtensions <Boolean>]
    [-AllowHeuristicADCallingLineIdResolution <Boolean>]
    [-AudioCodec <AudioCodecEnum>]
    [-AutomaticSpeechRecognitionEnabled <Boolean>]
    [-CallAnsweringRulesEnabled <Boolean>]
    [-CallSomeoneEnabled <Boolean>]
    [-ConfiguredInCountryOrRegionGroups <MultiValuedProperty>]
    [-ConfiguredInternationalGroups <MultiValuedProperty>]
    [-Confirm]
    [-ContactAddressList <AddressListIdParameter>]
    [-ContactRecipientContainer <OrganizationalUnitIdParameter>]
    [-ContactScope <CallSomeoneScopeEnum>]
    [-CountryOrRegionCode <String>]
    [-DefaultLanguage <UMLanguage>]
    [-DialByNamePrimary <DialByNamePrimaryEnum>]
    [-DialByNameSecondary <DialByNameSecondaryEnum>]
    [-DomainController <Fqdn>]
    [-EquivalentDialPlanPhoneContexts <MultiValuedProperty>]
    [-Extension <String>]
    [-FaxEnabled <Boolean>]
    [-ForceUpgrade]
    [-InCountryOrRegionNumberFormat <NumberFormat>]
    [-InfoAnnouncementEnabled <InfoAnnouncementEnabledEnum>]
    [-InfoAnnouncementFilename <String>]
    [-InputFailuresBeforeDisconnect <Int32>]
    [-InternationalAccessCode <String>]
    [-InternationalNumberFormat <NumberFormat>]
    [-LegacyPromptPublishingPoint <String>]
    [-LogonFailuresBeforeDisconnect <Int32>]
    [-MatchedNameSelectionMethod <DisambiguationFieldEnum>]
    [-MaxCallDuration <Int32>]
    [-MaxRecordingDuration <Int32>]
    [-Name <String>]
    [-NationalNumberPrefix <String>]
    [-NumberingPlanFormats <MultiValuedProperty>]
    [-OperatorExtension <String>]
    [-OutsideLineAccessCode <String>]
    [-PilotIdentifierList <MultiValuedProperty>]
    [-RecordingIdleTimeout <Int32>]
    [-SendVoiceMsgEnabled <Boolean>]
    [-TUIPromptEditingEnabled <Boolean>]
    [-UMAutoAttendant <UMAutoAttendantIdParameter>]
    [-VoIPSecurity <UMVoIPSecurityType>]
    [-WelcomeGreetingEnabled <Boolean>]
    [-WelcomeGreetingFilename <String>]
    [-WhatIf]
    [<CommonParameters>]

Description

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.

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 this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

Examples

Example 1

Set-UMDialPlan -Identity MyDialPlan -OutsideLineAccessCode 9

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

Example 2

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

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

Example 3

$csv=import-csv "C:\MyInCountryGroups.csv"

Set-UMDialPlan -Identity MyDialPlan -ConfiguredInCountryOrRegionGroups $csv

Set-UMDialPlan -Identity MyDialPlan -AllowedInCountryOrRegionGroups "local, long distance"

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

Parameters

-AccessTelephoneNumbers

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:MultiValuedProperty
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowDialPlanSubscribers

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowedInCountryOrRegionGroups

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:MultiValuedProperty
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowedInternationalGroups

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:MultiValuedProperty
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowExtensions

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowHeuristicADCallingLineIdResolution

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

The AllowHeuristicADCallingLineIdResolution parameter specifies whether to allow calling line ID resolution using telephone number fields that might 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 might 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 might not be able to correctly resolve the caller ID to a name of a user in a consistent manner.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AudioCodec

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:AudioCodecEnum
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AutomaticSpeechRecognitionEnabled

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CallAnsweringRulesEnabled

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CallSomeoneEnabled

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ConfiguredInCountryOrRegionGroups

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:MultiValuedProperty
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ConfiguredInternationalGroups

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:MultiValuedProperty
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.
  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ContactAddressList

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:AddressListIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ContactRecipientContainer

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:OrganizationalUnitIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ContactScope

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:CallSomeoneScopeEnum
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CountryOrRegionCode

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultLanguage

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:UMLanguage
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DialByNamePrimary

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:DialByNamePrimaryEnum
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DialByNameSecondary

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:DialByNameSecondaryEnum
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DomainController

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Parameter properties

Type:Fqdn
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EquivalentDialPlanPhoneContexts

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:MultiValuedProperty
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Extension

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FaxEnabled

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceUpgrade

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:UMDialPlanIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-InCountryOrRegionNumberFormat

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:NumberFormat
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InfoAnnouncementEnabled

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:InfoAnnouncementEnabledEnum
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InfoAnnouncementFilename

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputFailuresBeforeDisconnect

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InternationalAccessCode

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InternationalNumberFormat

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:NumberFormat
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LegacyPromptPublishingPoint

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

The LegacyPromptPublishingPoint parameter was used to specify the location of the prompt publishing point for Exchange Server 2007 Unified Messaging servers. This parameter was used in coexistence scenarios when Exchange 2007 Unified Messaging servers were also included in the UM dial plan.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LogonFailuresBeforeDisconnect

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MatchedNameSelectionMethod

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:DisambiguationFieldEnum
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxCallDuration

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxRecordingDuration

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NationalNumberPrefix

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NumberingPlanFormats

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:MultiValuedProperty
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OperatorExtension

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OutsideLineAccessCode

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PilotIdentifierList

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:MultiValuedProperty
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RecordingIdleTimeout

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SendVoiceMsgEnabled

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TUIPromptEditingEnabled

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UMAutoAttendant

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:UMAutoAttendantIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VoIPSecurity

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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.

Parameter properties

Type:UMVoIPSecurityType
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WelcomeGreetingEnabled

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WelcomeGreetingFilename

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

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.

Outputs

Output 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.