Get Interface Summary function
Summarize
Summary of Get Interface Summary function
TheGet Interface Summaryfunction in the Telecommunications Network Inventory application allows you to retrieve all network interface records related to a specified network asset such as a Site, Rack, or Equipment. It is designed for use within Workflow Studio to automate the retrieval of details about available interfaces, connected interfaces, and physical connections of telecommunications equipment.
Show less
This function requires input parameters identifying the network asset and returns comprehensive interface-related information, helping you manage and visualize network inventory effectively.
Key Features
- Input Flexibility: Accepts Site, Rack, or Equipment as input to fetch associated network interfaces.
- Error Handling: Reports errors if multiple inputs do not match or if there is a conflict in asset associations (e.g., equipment not belonging to the specified site).
- Workflow Studio Integration: Available as an action within Workflow Studio, enabling automation in Telecommunications Network Inventory workflows.
- Input Parameters: Includes Site, Rack, Equipment references, Availability Status options (Available, Used, Reserved, Shared), Physical Connection Model, and optional user-defined type, role, and function codes for categorization.
- Multiple Records Handling: Option to return only the first matching record if multiple records are found.
Input and Output Details
Inputs: You provide references to network assets (Site, Rack, Equipment) and can specify availability status and categorization codes to filter the results.
Outputs:
- Available Interfaces: List of sysid values for available network interfaces.
- Connected Interfaces: List of sysid values for interfaces connected to other assets.
- Physical Connections: List of sysid values for physical connections between interfaces.
Practical Example
When you input a specific equipment (e.g., Equipment-1), the function returns:
- Available Interfaces (e.g., Port-1)
- Connected Interfaces (e.g., Port-2, Port-3)
- Physical Connections between ports (e.g., PC-1, PC-2)
If configured to return only the first record, it limits output to the first available interface, connected interface, and physical connection respectively.
Roles and Availability
This function requires the admin role to add and configure actions in Workflow Studio. It is specifically available within the Telecommunications Network Inventory application to support inventory-related data operations.
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.