Get Interface Summary function
Summarize
Summary of Get Interface Summary function
The Get Interface Summary function in the Telecommunications Network Inventory application enables you to retrieve network interface records associated with specified inputs such as Site, Rack, or Equipment. This function is designed for use within Workflow Studio, helping you automatically obtain details about available interfaces, connected interfaces, and physical connections of network equipment.
Show less
This function is particularly useful for managing and visualizing network inventory data, ensuring accurate association between network entities like equipment and sites. If input conflicts or mismatches occur, the function reports errors with conflict details to aid troubleshooting.
Key Features
- Input Flexibility: Accepts Site, Rack, or Equipment references to filter network interfaces.
- Availability Status: Filters interfaces by asset status such as Available, Used, Reserved, or Shared.
- Physical Connection Model: Allows filtering by the physical connection model associated with interfaces.
- User-defined Categorization: Supports optional type, role, and function codes to categorize network entities.
- Multiple Record Handling: Offers an option to return either all matching records or only the first record found, helping to control output size and relevance.
- Workflow Studio Integration: Available as an action within Workflow Studio for seamless automation and orchestration in network inventory workflows.
Input and Output Details
Inputs: The function requires one or more references among Site, Rack, and Equipment. It also supports filtering by availability status, physical connection model, and optional categorization codes.
Outputs: The function returns three distinct lists of network interface sysids:
- Available Interfaces: Network interfaces currently available.
- Connected Interfaces: Network interfaces connected to other assets.
- Physical Connections: Associated physical connection records.
Practical Example
Given an equipment input (e.g., Equipment-1) connected to multiple ports and physical connections, the function outputs lists of available interfaces, connected interfaces, and physical connections associated with that equipment. Choosing to return only the first record streamlines the output to one interface and connection per category.
Role and Permissions
Users with the admin role can add and configure this function in Workflow Studio flows, enabling them to incorporate interface data retrieval into automation processes.
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
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
The following table lists the input fields in the Get Interface Summary function and their descriptions.
| 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:
|
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 |
To learn more about the variable data types, see Flow Designer input and output data variables.
Output
The following table lists the information about the function output.
| 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 |
Example
- Available Interface - Port-1
- Connected Interfaces - Port-2 and Port-3
- physical Connections - PC-1 and PC-2
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.