New-NectarNumberRange
- 15 May 2023
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
New-NectarNumberRange
- Updated on 15 May 2023
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Create a new Nectar range for DID Management
Syntax
New-NectarNumberRange
-RangeName <String>
-RangeType <String>
-FirstNumber <String>
-LastNumber <String>
-BaseNumber <String>
-ExtStart <String>
-ExtEnd <String>
-RangeSize <Int32>
-HoldDays <Int32>
-LocationName <String>
-TenantName <String>
-Identity <Int32>
Examples
Example 1
New-NectarNumberRange -RangeName DIDRange1 -RangeType STANDARD -FirstNumber +15552223333 -LastNumber +15552224444 -LocationName Dallas
Creates a DID range for numbers that fall in the range of +15552223333 to +15552224444
Example 2
New-NectarNumberRange -RangeName DIDRange1 -RangeType STANDARD -FirstNumber +15552223000 -RangeSize 1000 -LocationName Dallas
Creates a DID range for numbers that fall in the range of +15552223000 to +15552223999
Example 3
New-NectarNumberRange -RangeName ExtRange1 -RangeType EXTENSION -BaseNumber +15552223000 -ExtStart 2000 -ExtEnd 2999 -LocationName Dallas
Creates an extension range for numbers that fall in the range of +15552223000 x2000 to x2999
Parameters
-RangeName <String>
The name of the new range. Must be unique.
| Parameter | Value |
|---|---|
| Required | true |
| Position | 1 |
| Required | true |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-RangeType <String>
The type of range. Can be either STANDARD (for DID ranges) or EXTENSION (for extension-based ranges).
| Parameter | Value |
|---|---|
| Required | true |
| Position | 2 |
| Required | true |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-FirstNumber <String>
The first number in a STANDARD range. Must be numeric, but can start with +.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-LastNumber <String>
The last number in a STANDARD range. Must be numeric, but can start with +. Must be larger than FirstNumber, and must have the same number of digits.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-BaseNumber <String>
The base DID for an EXTENSION range. Must be numeric, but can start with +.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-ExtStart <String>
The first extension number in an EXTENSION range. Must be numeric.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 6 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-ExtEnd <String>
The last extension number in an EXTENSION range. Must be numeric. Must be larger than ExtStart, and must have the same number of digits.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 7 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-RangeSize <Int32>
The number of phone numbers/extensions in a range. Can be used instead of LastNumber/ExtEnd.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 8 |
| Required | false |
| Default Value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-HoldDays <Int32>
The number of days to hold a newly-freed number before returning it to the pool of available numbers.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 9 |
| Required | false |
| Default Value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-LocationName <String>
The location to assign the range to.
| Parameter | Value |
|---|---|
| Required | true |
| Position | 10 |
| Required | true |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 11 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-Identity <Int32>
| Parameter | Value |
|---|---|
| Required | false |
| Position | 12 |
| Required | false |
| Default Value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Was this article helpful?