--- 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 --- # Get Interface Summary function # Get Interface Summary function {#ariaid-title1} Release version: Australia Updated March 12, 2026 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete. ## Summary of Get Interface Summary function The Get Interface Summary function in the Telecommunications Network Inventory application allows ServiceNow users to retrieve all network interface records associated with a given input such as a Site, Rack, or Equipment. It is designed for use within Workflow Studio to automate retrieval of interface details, including available interfaces, connected interfaces, and physical connections related to network equipment. Show full answer Show less This function requires specifying one of the input references (Site, Rack, or Equipment) and returns detailed interface information. If multiple inputs conflict or do not match correctly, the function reports an error to ensure data consistency. ## Key Features * Input parameters include references to Site, Rack, Equipment, Availability status, Physical connection model, and optional user-defined codes for Type, Role, and Function. * Handles multiple matching records with an option to return only the first matched record for streamlined results. * Outputs three key lists of sysid values: Available Interfaces, Connected Interfaces, and Physical Connections. * Accessible as a Workflow Studio action, enabling integration into automated workflows for inventory data operations. * Requires admin role to configure and add this action to workflows. ## Practical Use and Example For example, given an equipment input, the function can return the network ports that are available, connected, and the physical connections between ports. When configured to return only the first record upon multiple matches, it provides a concise summary for efficient processing. ## Benefits for ServiceNow Customers * Automates retrieval of network interface data, reducing manual effort. * Ensures accurate association of interfaces with their physical and logical network assets. * Supports detailed inventory management and troubleshooting within Telecommunications Network Inventory workflows. * Improves workflow efficiency by providing configurable output handling for multiple matches. 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. The Get Interface Summary function enables you to retrieve the network interface records that are associated with the input such as Site, Rack, or Equipment. You must enter the site, equipment, or rack value to return the output. If multiple inputs don't match, the action reports an error. For example, let's say that you can see the equipment and site details but because the equipment doesn't belong to the site, the system reports an error with the conflict information. You can use this function as a Workflow Studio action in the Telecommunications Network Inventory workflow. ## Roles and availability {#get-interface-summary-action__section_kfd_fdk_x5b} Users with the 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 {#get-interface-summary-action__section_y33_w2k_x5b} The following table lists the input fields in the Get Interface Summary function and their descriptions. {#get-interface-summary-action__table_w3g_2fm_1vb__entry__3} | Field Name | Description | Data Type | |-|-|-| | Site | Network site that is associated with the network interface. | Reference.Network Site | | Rack | Rack that is associated with the network interface. | Reference.Telco equipment | | Equipment | Equipment that is associated with the network interface. | Reference.Telco equipment | | Availability | Status of the network asset. You can select one from the following options: * Available * Used * Reserved * Shared {#get-interface-summary-action__ul_vl2_25y_25b} | Choice | | Model | Physical connection model that is associated with the network interface. | Reference.Physical Connection Model | | Type | Optional user-defined type code that you use to categorize the types of the various network entities or assets. | Reference.TRF Value | | Role | Optional user-defined role code that you use to categorize the roles or purposes of the various network entities or assets. | Reference.TRF Value | | Function | Optional user-defined function code that you use to categorize the functions of the various network entities or assets. | Reference.TRF Value | | If multiple records are found action | Option to return the type of output when multiple records are found. You can select Return only the first record from the list to return the first interface network record. | Choice | [Table 1. Input fields of Get Interface Summary function] {#get-interface-summary-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 {#get-interface-summary-action__section_rnx_nxn_dvb} The following table lists the information about the function output. {#get-interface-summary-action__table_snx_nxn_dvb__entry__3} | Name | Description | Data Type | |-|-|-| | Available Interfaces | Returns the sys_id list of the available network interfaces. | Array.String | | Connected Interfaces | Returns the sys_id list of the network interfaces that are connected to the other network assets. | Array.String | | Physical Connections | Returns the sys_id list of the physical connections. | Array.String | [Table 2. Output of function] {#get-interface-summary-action__table_snx_nxn_dvb} ## Example {#get-interface-summary-action__section_hdk_y2k_x5b} If the input is passed as Equipment-1 as shown in the following example where Port-1, Port-2, and Port-3 are connected to Equipment-1, Port-4 and Port-5 are connected to Equipment-2, physical connection-1 between Port-2 and Port-4, and physical connection-2 between Port-3 and Port-5. Then the output is as follows: * Available Interface - Port-1 * Connected Interfaces - Port-2 and Port-3 * physical Connections - PC-1 and PC-2 {#get-interface-summary-action__ul_upn_y1t_fvb} If you select If multiple records are found action as Return only the first record, it returns Port-1, Port-2, and PC-1, respectively. **Related concepts** * [Allocate Free Number function](https://servicenow-prod.fluidtopics.net/PuuJW2JxrgTywUnIAXcLeg "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.") * [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.") * [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.")