Get Interface Summary function

  • Release version: Yokohama
  • Updated January 30, 2025
  • 2 minutes to read

    • 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.

    Table 1. Input fields of Get Interface Summary function
    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
    		 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.

    Table 2. Output of function
    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

    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
    Infographic displaying the connections from the Get Interface Summary action. For the text description, refer to the example description that follows.

    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.