Topic Last Modified: 2010-10-01

Modifies an existing range of unassigned numbers and the routing rules that apply to those numbers.

Syntax

Set-CsUnassignedNumber [-Identity <XdsGlobalRelativeIdentity>] [-NumberRangeStart <String>] [-NumberRangeEnd <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-Priority <Int32>] [-WhatIf [<SwitchParameter>]]
Set-CsUnassignedNumber [-Identity <XdsGlobalRelativeIdentity>] [-NumberRangeStart <String>] [-NumberRangeEnd <String>] -ExUmAutoAttendantPhoneNumber <String> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-Priority <Int32>] [-WhatIf [<SwitchParameter>]]
Set-CsUnassignedNumber [-Identity <XdsGlobalRelativeIdentity>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Priority <Int32>] [-WhatIf [<SwitchParameter>]]
Set-CsUnassignedNumber [-Identity <XdsGlobalRelativeIdentity>] [-NumberRangeStart <String>] [-NumberRangeEnd <String>] -AnnouncementService <String> -AnnouncementName <String> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-Priority <Int32>] [-WhatIf [<SwitchParameter>]]
Set-CsUnassignedNumber [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-Priority <Int32>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Optional

String

The unique name for the range of unassigned numbers being modified.

Instance

Optional

DisplayAnnouncementVacantNumberRange

A reference to an object containing unassigned number settings. This object must be of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange and can be retrieved by calling the Get-CsUnassignedNumber cmdlet.

AnnouncementName

Required

String

The name of the Announcement that will be used to handle calls to this range of numbers.

AnnouncementService

Required

String

The fully qualified domain name (FQDN) or service ID of the Announcement server.

ExUmAutoAttendantPhoneNumber

Required

String

The phone number of the Exchange UM Auto Attendant to route calls in this range to. The Exchange UM Auto Attendant contact must already be set up in order to assign a value to this parameter.

NumberRangeStart

Optional

String

The first number in the range of unassigned numbers. Must be less than or equal to the value supplied for NumberRangeEnd.

The number must match the regular expression (tel:)?(\+)?[1-9]\d{0,17}(;ext=[1-9]\d{0,9})?. This means the number may begin with the string tel: (if you don’t specify that string it will be automatically added for you), a plus sign (+), and a digit 1 through 9. The phone number can be up to 17 digits and may be followed by an extension in the format ;ext= followed by the extension number.

NumberRangeEnd

Optional

String

The last number in the range of unassigned numbers. Must be greater than or equal to the number supplied for NumberRangeStart. To specify a range of one number, use the same number for the NumberRangeStart and NumberRangeEnd.

The number must match the regular expression (tel:)?(\+)?[1-9]\d{0,17}(;ext=[1-9]\d{0,9})?. This means the number may begin with the string tel: (if you don’t specify that string it will be automatically added for you), a plus sign (+), and a digit 1 through 9. The phone number can be up to 17 digits and may be followed by and extension in the format ;ext= followed by the extension number.

Priority

Optional

Int32

It is possible for unassigned number ranges to overlap. If a number falls within more than one range, the range with the highest priority will take effect.

Force

Optional

SwitchParameter

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

WhatIf

Optional

SwitchParameter

Describes what would happen if you executed the command without actually executing the command.

Confirm

Optional

SwitchParameter

Prompts you for confirmation before executing the command.

Detailed Description

Unassigned numbers are phone numbers that have been assigned to an organization but that have not been assigned to specific users or phones. Microsoft Lync Server 2010 can be set up to route calls to appropriate destinations when an unassigned number is called. This cmdlet modifies the settings that define that routing.

In order to modify some of the settings for this cmdlet, your system must already either have Announcements defined or an Exchange Unified Messaging (UM) Auto Attendant set up. To determine whether you have Announcements, call the Get-CsAnnouncement cmdlet. To create a new Announcement, call New-CsAnnouncement. To check on Exchange UM Auto Attendant settings, run the Get-CsExUmContact cmdlet.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsUnassignedNumber cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsUnassignedNumber"}

Input Types

Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange object. Accepts pipelined input of unassigned number objects.

Return Types

This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange.

Example

-------------------------- Example 1 --------------------------

Copy Code 
Set-CsUnassignedNumber -Identity UNSet1 -NumberRangeStart "+14255551000" -NumberRangeEnd "+14255551900"

This example modifies the unassigned number range with the name UNSet1. We first pass the Identity parameter the value UNSet1, the name of the unassigned number range we want to modify. We then use the NumberRangeStart (+14255551000) and NumberRangeEnd (+14255551900) parameters to modify the range of unassigned numbers to which the specified announcement or Auto Attendant will apply.

-------------------------- Example 2 --------------------------

Copy Code 
Get-CsUnassignedNumber | Where-Object {$_.AnnouncementName -match "Welcome"} | Set-CsUnassignedNumber -AnnouncementService ApplicationServer:redmond.litwareinc.com -AnnouncementName "Help Desk Announcement"

This example modifies the Announcement of all unassigned number range settings that currently have an Announcement with the string "Welcome" in the name. First we call Get-CsUnassignedNumber to retrieve all unassigned number settings. We pipe that collection of settings to Where-Object, which narrows down the collection to only those settings where the AnnouncementName property contains (-match) the string Welcome. Once we have those settings, we pipe them to Set-CsUnassignedNumber, where we modify the Application Server ID of the Announcement Service (ApplicationServer:redmond.litwareinc.com) with the AnnouncementService parameter and the name of the new announcement (Help Desk Announcement) with the AnnouncementName parameter. Note that even if the new Announcement has a different name but the same service ID, you must still specify the service ID along with the name.

See Also