インターフェイスサマリー関数を取得
[インターフェイスサマリーを取得 (Get Interface Summary)] 機能を使用すると、入力に関連付けられているすべてのネットワークインターフェイスレコードを取得できます。この機能を使用すると、ワークフロースタジオを使用するときに、通信事業ネットワークインベントリアプリケーションで利用可能なインターフェイス、接続されているインターフェイス、および機器の物理接続の詳細を自動的に取得できます。
Get Interface Summary 機能を使用すると、サイト、ラック、機器などの入力に関連付けられているネットワークインターフェイスレコードを取得できます。出力を返すには、サイト、機器、またはラックの値を入力する必要があります。
複数の入力が一致しない場合、アクションはエラーを報告します。たとえば、設備とサイトの詳細を表示できるものの、設備がサイトに属していないため、競合情報を含むエラーが報告されるとします。
この関数は、通信事業ネットワークインベントリワークフローのワークフロースタジオアクションとして使用できます。
ロールと可用性
admin ロールを持つユーザーは、アクションをフローに追加し、フローの構成の詳細を定義できます。この機能は、インベントリ関連のデータ操作を実行できるように、通信事業ネットワークインベントリ アプリケーションのワークフロースタジオアクションとして使用できます。
入力フィールド
次の表に、入力フィールド インターフェイスサマリー取得関数 とその説明を示します。
| フィールド名 | 説明 | データタイプ |
|---|---|---|
| サイト | ネットワークインターフェイスに関連付けられているネットワークサイト。 | Reference.Network サイト |
| ラック | ネットワークインターフェイスに関連付けられているラック。 | Reference.Telco 機器 |
| 設備 | ネットワークインターフェイスに関連付けられている機器。 | Reference.Telco 機器 |
| Availability |
ネットワーク資産のステータス。次のオプションのいずれかを選択できます。
|
選択肢 |
| モデル | ネットワークインターフェイスに関連付けられている物理接続モデル。 | Reference.物理接続モデル |
| タイプ | さまざまなネットワークエンティティまたは資産のタイプを分類するために使用するオプションのユーザー定義タイプコード。 | Reference.TRF 値 |
| ロール | さまざまなネットワークエンティティまたは資産のロールまたは目的を分類するために使用するオプションのユーザー定義ロールコード。 | Reference.TRF 値 |
| 関数 | さまざまなネットワークエンティティまたは資産の機能を分類するために使用するオプションのユーザー定義関数コード。 | Reference.TRF 値 |
| 複数のレコードが見つかった場合のアクション | 複数のレコードが見つかった場合に出力のタイプを返すオプション。リストから 最初のレコードのみを返すを選択する と、最初のインターフェイスネットワークレコードを返すことができます。 | 選択肢 |
変数データタイプの詳細については、「 フローデザイナーの入力データ変数および出力データ変数」を参照してください。
出力
次の表に、関数の出力に関する情報を示します。
| 名前 | 説明 | データタイプ |
|---|---|---|
| 利用可能なインターフェイス | 利用可能なネットワークインターフェイスのsys_idリストを返します。 | Array.String |
| 接続されているインターフェイス | 他のネットワーク資産に接続されているネットワークインターフェイスのsys_idリストを返します。 | Array.String |
| 物理接続 | 物理接続のsys_idリストを返します。 | Array.String |
例
- 利用可能なインターフェイス:ポート 1
- 接続されているインターフェイス - ポート 2 およびポート 3
- 物理接続 - PC-1 および PC-2
[ 複数のレコードが見つかった場合] アクション を [ 最初のレコードのみを返す] に選択した場合は、それぞれポート 1、ポート 2、および PC-1 が返されます。