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

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：3分

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

    概要

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

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

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

    ロールと使用可用性

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

    入力フィールド

    次の表に、[インターフェイス サマリーを取得(Get Interface Summary)] 関数の入力フィールドとその説明を示します。

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

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

    出力

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

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

    例

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

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