{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":51204,"path":"telecom-network-inventory/telecommunications-network-inventory/allocate-free-number-action.md","title":"Allocate Free Number function","bundle":null,"doc_type":null,"release":"australia","body":"\n# Allocate Free Number function\n\nThe 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.\n\nYou use the Allocate Free Number function to do the following actions:\n\n-   Assign the free number from a number range that is in the inventory record.\n-   Get the free number from the number range and create the inventory number record as a child number.\n-   Add the free numbers against the CI in a number element.\n\nYou can use this function as a Workflow Studio action in the Telecommunications Network Inventory workflow.\n\n## Roles and availability\n\nAn 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.\n\n## Input fields\n\nThe following table lists the input fields in the Allocate Free Number action and their descriptions.\n\n<table id=\"table_w3g_2fm_1vb\"><thead><tr><th>\n\nField Name\n\n</th><th>\n\nDescription\n\n</th><th>\n\nType\n\n</th></tr></thead><tbody><tr><td>\n\nNumber Range\n\n</td><td>\n\nInventory number record where you need the free number for.\n\n</td><td>\n\nReference.Inventory Number record\n\n</td></tr><tr><td>\n\nCount\n\n</td><td>\n\nTotal count of the free numbers.\n\n</td><td>\n\nInteger\n\n</td></tr><tr><td>\n\nNumber Type\n\n</td><td>\n\nType of network connection that you need the free numbers for. Select one of the following:-   **VLAN**\n\nSingle VLAN number record.\n\n-   **LAG**\n\nSingle LAG number record.\n\n\n</td><td>\n\nChoice\n\n</td></tr><tr><td>\n\nOwned by configuration item\n\n</td><td>\n\nConfiguration item \\(CI\\) that is related to the Inventory number record.\n\n</td><td>\n\nReference.Configuration Item\n\n</td></tr><tr><td>\n\nConsecutive\n\n</td><td>\n\nOption to return the consecutive free numbers.\n\n</td><td>\n\nTrue/False\n\n</td></tr></tbody>\n</table>To learn more about the variable data types, see [Flow Designer input and output data variables](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/build-workflows/action-inputs-outputs.md).\n\n## Output\n\nThe following table lists the information about the function output.\n\n|Name|Description|Type|\n|----|-----------|----|\n|FinalRecordList|Returns the list of inventory number records for the number range.|Array.Integer|\n\n## Example\n\nConsider 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.\n\n**Parent Topic:**[Telecommunications Network Inventory function catalog](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/telecom-network-inventory/telecommunications-network-inventory/tni-flow-action.md)\n\n**Related topics**  \n\n\n[Create CI From Template function]()\n\n[Cascade Update function]()\n\n[Create and Assign Range/Single Number function]()\n\n[Create Logical Interface function]()\n\n[Create Logical Connection function]()\n\n[Create Physical Connection function]()\n\n[Create IP subnetwork function]()\n\n[CIDR to IP range function]()\n\n[Get Interface Summary function]()\n\n[Lookup Next Hub function]()\n\n[Path Search function]()\n\n"}}