Get Interface Summary function

  • Release version: Zurich
  • Updated July 31, 2025
  • 2 minutes to read
    • Summarize
    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 enables you to retrieve all network interface records associated with a given input, such as Site, Rack, or Equipment. It is designed to automatically fetch details about available interfaces, connected interfaces, and physical connections of network equipment, and is primarily used within Workflow Studio as an action in inventory-related workflows.

    Show full answer Show less

    This function requires you to specify one of the inputs (Site, Rack, or Equipment) and returns network interface data linked to that input. If conflicting or multiple unmatched inputs are provided, the function reports an error to highlight inconsistencies in the inventory data.

    Key Features

    • Input Flexibility: Accepts Site, Rack, or Equipment references to identify associated network interfaces.
    • Additional Filters: Allows filtering by availability status (Available, Used, Reserved, Shared), physical connection model, and user-defined codes for type, role, and function of network assets.
    • Multiple Records Handling: Option to return all matching records or only the first record found, providing control over output granularity.
    • Workflow Studio Integration: Available as an action for users with admin role to add and configure within workflows, facilitating automated inventory management.

    Inputs

    The main input fields include:

    • Site: Reference to the network site.
    • Rack: Reference to the rack associated with interfaces.
    • Equipment: Reference to equipment linked to the interfaces.
    • Availability: Status filter for network assets.
    • Physical Connection Model, Type, Role, Function: Optional references for more precise filtering based on physical model and user-defined categorizations.
    • If multiple records are found: Choice to return only the first record or all matching records.

    Outputs

    The function returns three lists containing the sysid values of network interfaces and connections:

    • Available Interfaces: List of available network interfaces.
    • Connected Interfaces: List of network interfaces connected to other assets.
    • Physical Connections: List of physical connection identifiers.

    Practical Use Case

    For example, when you input a specific equipment, such as "Equipment-1," the function returns:

    • Available Interfaces: Interfaces on Equipment-1 not connected to others (e.g., Port-1).
    • Connected Interfaces: Interfaces connected to other equipment (e.g., Port-2 and Port-3).
    • Physical Connections: Physical connections between ports (e.g., PC-1 and PC-2).

    If the option to return only the first record is selected, the output includes just the first available interface, connected interface, and physical connection, simplifying the results.

    Roles and Availability

    Only users with the admin role can add this function as an action within Workflow Studio and configure its parameters. It is specifically available in the Telecommunications Network Inventory application to support network inventory automation.

    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.