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

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：3分

    • [インターフェイスの概要を取得] 機能を使用すると、入力に関連付けられているすべてのネットワークインターフェイスレコードを取得できます。この機能を使用すると、ワークフロースタジオ を使用するときに、通信事業ネットワークインベントリ アプリケーションで使用可能なインターフェイス、接続されているインターフェイス、および機器の物理接続の詳細を自動的に取得できます。

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

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

    この機能は、通信事業ネットワークインベントリワークフローのワークフロースタジオアクションとして使用できます。

    ロールと可用性

    admin ロールを持つユーザーは、アクションをフローに追加し、フローの構成の詳細を定義できます。この機能は、インベントリ関連のデータ操作を実行できるように、通信事業ネットワークインベントリ アプリケーションでワークフロースタジオアクションとして使用できます。

    入力フィールド

    次の表に、[インターフェイスの概要を取得] 関数の入力フィールド とその説明 を示します。

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

    変数データ型の詳細については、「 フローデザイナーの入力データ変数と出力データ変数」を参照してください。

    出力

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

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

    例

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

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