インターフェイスサマリー関数を取得

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む3読むのに数分
  • Get Interface Summary 関数を使用すると、入力に関連付けられているすべてのネットワークインターフェイスレコードを取得できます。この機能を使用すると、使用可能なフローデザイナーインターフェイス、接続されているインターフェイス、およびアプリケーション内のTelecommunications Network Inventory機器の物理的な接続の詳細を自動的に取得できます。

    概要

    [インターフェイスサマリーを取得 (Get Interface Summary)] 機能を使用すると、サイト、ラック、機器などの入力に関連付けられているネットワークインターフェイスレコードを取得できます。出力を返すには、サイト、機器、またはラックの値を入力する必要があります。

    複数の入力が一致しない場合、アクションはエラーを報告します。たとえば、機器とサイトの詳細を表示できるが、機器がサイトに属していないため、競合情報とともにエラーが報告されるとします。

    この機能は、ワークフロー内のTelecommunications Network Inventoryアクションとしてフローデザイナー使用できます。

    ロールと可用性

    admin ロールを持つユーザーは、フローにアクションを追加し、フローの構成の詳細を定義できます。この機能は、在庫関連のデータ操作を実行できるように、アプリケーションのアクションTelecommunications Network Inventoryとして使用するフローデザイナーことができます。

    入力フィールド

    次の表に、Get Interface Summary 関数の入力フィールドとその説明を示します。

    表 : 1. Get Interface Summary 関数の入力フィールド
    フィールド名 説明 データタイプ 必須?
    サイト ネットワークインターフェイスに関連付けられているネットワークサイト。 参考資料.ネットワークサイト いいえ
    ラック ネットワークインターフェイスに関連付けられているラック。 参考資料.電気通信機器所有者 いいえ
    設備 ネットワークインターフェイスに関連付けられている機器。 参考資料.Telco 機器 いいえ
    可用性
    ネットワーク資産のステータス。次のオプションから 1 つを選択できます。
    • 利用可能
    • 使用済み
    • 予約済み
    • 共有しました
    選択肢 いいえ
    モデル ネットワークインターフェイスに関連付けられている物理接続モデル。 Reference.物理接続モデル いいえ
    タイプ さまざまなネットワークエンティティまたは資産のタイプを分類するために使用するオプションのユーザー定義タイプコード。 Reference.TRF 値 いいえ
    ロール さまざまなネットワークエンティティまたは資産のロールまたは目的を分類するために使用するオプションのユーザー定義ロールコード。 Reference.TRF 値 いいえ
    関数 さまざまなネットワークエンティティまたは資産の機能を分類するために使用するオプションのユーザー定義関数コード。 Reference.TRF 値 いいえ
    複数のレコードが見つかった場合のアクション 複数のレコードが見つかった場合に出力のタイプを返すオプション。[ リストから最初のレコードのみを返す ] を選択すると、最初のインターフェイスネットワークレコードが返されます。 選択肢 いいえ

    変数のデータタイプについての詳細は、「 Flow Designer の入力データ変数と出力データ変数」を参照してください。

    出力

    次の表に、関数の出力に関する情報を示します。

    表 : 2. 関数の出力
    名前 説明 データタイプ
    利用可能なインターフェイス 利用可能なネットワークインターフェイスのsys_idリストを返します。 Array.String
    接続されているインターフェイス 他のネットワーク資産に接続されているネットワークインターフェイスのsys_idリストを返します。 Array.String
    物理接続 物理接続のsys_idリストを返します。 Array.String

    次の例 のように、ポート 1、ポート 2、およびポート 3 が Equipment-1 に接続されているように、入力が Equipment-1 として渡された場合、ポート 4 とポート 5 は Equipment-2 に接続され、物理接続 1 はポート 2 とポート 4 の間、物理接続 2 はポート 3 とポート 5 の間に接続されます。出力 は次のようになります。
    • 利用可能なインターフェイス:ポート 1
    • 接続されているインターフェイス:ポート 2 およびポート 3
    • 物理接続 - PC-1 および PC-2
    [インターフェイスサマリーを取得 (Get Interface Summary)] アクションからの接続を表示するインフォグラフィック。テキストの説明については、以下の説明例を参照してください。

    [複数のレコードが見つかった場合のアクション] として [最初のレコードのみを返す] を選択すると、それぞれ Port-1、Port-2、および PC-1 が返されます。