Get-CsUnassignedNumber
Topic Last Modified: 2012-03-23
Retrieves one or more ranges of unassigned numbers and the routing rules that apply to those numbers.
Syntax
Get-CsUnassignedNumber [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>]
Get-CsUnassignedNumber [-Filter <String>] [-LocalStore <SwitchParameter>]
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 retrieves one or more unassigned number ranges that define that routing.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsUnassignedNumber cmdlet locally: RTCUniversalUserAdmins, RTCUniversalServerAdmins, RTCUniversalReadOnlyAdmin. 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 "Get-CsUnassignedNumber"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsGlobalRelativeIdentity |
The unique name of the unassigned number range to retrieve. |
Filter |
Optional |
String |
Performs a wildcard search that allows you to narrow down your results to only those unassigned number settings whose identities match the given wildcard string. |
LocalStore |
Optional |
SwitchParameter |
Retrieves the unassigned number information from the local replica of the Central Management store, rather than the Central Management store itself. |
Input Types
None.
Return Types
Returns an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange.
Example
-------------------------- Example 1 --------------------------
Get-CsUnassignedNumber
Example 1 returns a collection of all the unassigned numbers configured for use in your organization.
-------------------------- Example 2 --------------------------
Get-CsUnassignedNumber -Identity UNSet1
In Example 2, the Identity parameter is used to limit the retrieved data to unassigned numbers that have the Identity UNSet1. Because identities must be unique, this command will return only the specified unassigned number range.
-------------------------- Example 3 --------------------------
Get-CsUnassignedNumber -Filter *Redmond*
This example uses the Filter parameter to return a collection of all the unassigned number settings with Identity values that include the string Redmond. For example, this command would return unassigned number setting with identities such as Redmond Numbers, Unassigned Redmond Numbers, UNRedmond, etc.
-------------------------- Example 4 --------------------------
Get-CsUnassignedNumber | Where-Object {$_.AnnouncementName -match "Welcome"}
In Example 4, Get-CsUnassignedNumber and Where-Object are used to retrieve a collection of all the unassigned number settings that include the word Welcome in the name of the Announcement. To do this, the command first uses Get-CsUnassignedNumber to retrieve all the unassigned number settings. That collection is then piped to Where-Object, which applies a filter that limits the returned data to unassigned numbers that have the word Welcome somewhere in the name of the assigned announcement.