---
sourceDocument: Australia Telecommunications Network Inventory
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/telecom-network-inventory

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia Telecommunications Network Inventory

ft:clusterId :

    - telninv

bundleId :

    - telninv

workflow :

    - Customer and Industry


---

# Allocate Free Number function

# Allocate Free Number function {#ariaid-title1}

Release version: Australia  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read  
The Allocate Free Number function enables you to assign free numbers from the Telecommunications Network Inventory number record. You use this function to allocate a quantity of numbers from a specified range to add against the configuration item (CI) in a number element.
You use the Allocate Free Number function to do the following actions:

* Assign the free number from a number range that is in the inventory record.
* Get the free number from the number range and create the inventory number record as a child number.
* Add the free numbers against the CI in a number element.
{#allocate-free-number-action__ul_cdb_m1p_t5b}

You can use this function as a Workflow Studio action in the Telecommunications Network Inventory workflow.

## Roles and availability {#allocate-free-number-action__section_kfd_fdk_x5b}

An admin role can add an action to a flow and define the configuration details of the flow. This function is available as a Workflow Studio action in the Telecommunications Network Inventory application so that you can perform inventory-related data operations.

## Input fields {#allocate-free-number-action__section_vvs_jpr_x5b}

The following table lists the input fields in the Allocate Free Number action and their descriptions.
{#allocate-free-number-action__table_w3g_2fm_1vb__entry__3}

| Field Name | Description | Type |
|-|-|-|
| Number Range | Inventory number record where you need the free number for. | Reference.Inventory Number record |
| Count | Total count of the free numbers. | Integer |
| Number Type | Type of network connection that you need the free numbers for. Select one of the following: VLAN :   Single VLAN number record. LAG :   Single LAG number record. | Choice |
| Owned by configuration item | Configuration item (CI) that is related to the Inventory number record. | Reference.Configuration Item |
| Consecutive | Option to return the consecutive free numbers. | True/False |
[Table 1. Input fields of Allocate Free Number function]

{#allocate-free-number-action__table_w3g_2fm_1vb}

To learn more about the variable data types, see [Flow Designer input and output data variables](https://www.servicenow.com/docs/access?context=action-inputs-outputs&version=australia&pubname=australia-build-workflows&ft:locale=en-US).

## Output {#allocate-free-number-action__section_adz_wwm_dvb}

The following table lists the information about the function output.
{#allocate-free-number-action__table_fxx_wxm_dvb__entry__3}

| Name | Description | Type |
|-|-|-|
| FinalRecordList | Returns the list of inventory number records for the number range. | Array.Integer |
[Table 2. Output of function]

{#allocate-free-number-action__table_fxx_wxm_dvb}

## Example {#allocate-free-number-action__section_i5v_kpr_x5b}

Consider that a VLAN has 1--4096 as the number range and 1--1000, 1001--2500, and 2510--4096 are the subranges. If you give the count as 4, the function returns the list of inventory number records for 2501, 2502, 2503, and 2504.
These numbers are free in the VLAN number range.
**Related concepts**   

* [Create CI From Template function](https://servicenow-prod.fluidtopics.net/LL~zoSfWRCAzN6vgmL65sw "The TNI Create CI From Template function enables you to create the inventory instance in the designated site or equipment holder in the Telecommunications Network Inventory application. This occurs when you instantiate an inventory with the inventory template. You can automatically create the inventory when you instantiate the network inventory design and assign process.")
* [Cascade Update function](https://servicenow-prod.fluidtopics.net/W97Jp~xw_w8ibvUCGhteRw "The Cascade Update function enables you to update a configuration item (CI) attribute in the Telecommunications Network Inventory application and cascade the change in all related CIs. You can use this function to automatically cascade the field values in related CIs when you use Workflow Studio.")
* [Create and Assign Range/Single Number function](https://servicenow-prod.fluidtopics.net/gjw3tsjWew5ep25EHTlyEA "The Create and Assign Range/Single Number function enables you to create the inventory number records for a number range when you process the network inventory workflow.")
* [Create Logical Interface function](https://servicenow-prod.fluidtopics.net/2nX46P9be0B6QeJSId3OKA "The Create Logical Interface function enables you to create logical interfaces in the Telecommunications Network Inventory application.")
* [Create Logical Connection function](https://servicenow-prod.fluidtopics.net/DgjILFpYXEo~QjRh9KK9ZQ "The Create Logical Connection function enables you to create a logical connection record in the Telecommunications Network Inventory application based on the input (interfaces) that you receive when you instantiate an inventory.")
* [Create Physical Connection function](https://servicenow-prod.fluidtopics.net/7ieQdTkzr9dlznGE7OWaYw "The Create Physical Connection function enables you to create a physical connection record in the Telecommunications Network Inventory application based on the input that you receive when you instantiate an inventory.")
* [Create IP subnetwork function](https://servicenow-prod.fluidtopics.net/A5Gcil3U92nQAk1e9LyYJQ)
* [CIDR to IP range function](https://servicenow-prod.fluidtopics.net/2zW3eRjGoF3fvMBCMr30Ww "Classless Inter-Domain Range (CIDR) to IP range flow action enables you to create a set of IP addresses using the Classless Inter-Domain Range (CIDR) using Telecommunications Network Inventory application based on the input that you receive when you instantiate an inventory.")
* [Get Interface Summary function](https://servicenow-prod.fluidtopics.net/eBCtV3e6ngo0JOIWyFGiJw "The Get Interface Summary function enables you to retrieve all the network interface records that are associated with the input. You can use this function to automatically get the details of the available interface, connected interface, and the physical connection of the equipment in the Telecommunications Network Inventory application when you use Workflow Studio.")
* [Lookup Next Hub function](https://servicenow-prod.fluidtopics.net/ZzBLvcSLnnYarEgYkudhZQ "The Lookup Next Hub function enables you to take the network interface record as input and return the details of the related physical connection record. You can automatically get the details of the physical connection and interconnected ports of the equipment in the Telecommunications Network Inventory application when you use the Workflow Studio application.")
* [Path Search function](https://servicenow-prod.fluidtopics.net/Y0XR1w7cHadZ_06YQjXcOQ "The Path Search function enables you to execute the path computation function between the starting and ending sites in the Telecommunications Network Inventory application. You can use this function for the path computation when you process the network inventory design and assign.")

