Cisco DCNM Web サービス API ガイド リリース 5.1(1a)
FabricPathResourcesApp サービス
FabricPathResourcesApp サービス
発行日;2012/02/02 | 英語版ドキュメント(2011/07/18 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

FabricPathResourcesApp サービス

FabricPathResourcesApp サービスについて

getFabricPathConflictedPortsInNetworkElements

getFabricPathSettingsInNetworkElements

getFabricPathTopologySettingsInNetworkElements

modifyFabricPathSettings

performFabricPathForceLinkBringupInNetworkElements

FabricPathResourcesApp サービス

この章では、DCNM Web サービスの、FabricPathResourcesApp に対応する API メソッドについて説明します。この API は、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

FabricPathResourcesApp サービスについて

FabricPathResources は、FabricPath のリソース割り当てプロトコルです。FabricPath リソース情報の配信は、Intermediate System to Intermediate System(ISIS)を介して処理されます。SwitchId および FTAG は、FabricPath データ転送プレーンの識別子です。SwitchId は各 FabricPath スイッチに対する固有識別情報であり、TopologyId はそのスイッチが属する識別子です。PathId は FabricPath クラウド内にある次のデバイスへの最短パスの識別子です。FTAG は TopologyId と PathId で構成されます。API は次のカテゴリで定義されます。

1. Query/Get API:永続的なデータベースからデータを照会します。

2. Modify API:既存の FabricPath リソース設定を変更します。

3. Perform API:FabricPath リソース グローバル コンフィギュレーションを実行します。

getFabricPathConflictedPortsInNetworkElements

ネットワーク要素に対応する FabricPath の競合ポート情報を戻します。特定の InstanceNameId がヌルの場合、このメソッドは、サーバによって検出されたすべてのネットワーク要素の FabricPathConflictStatus が含まれる SwitchedNetworkInterface オブジェクトを戻します。

渡された引数 InstanceNameId InstanceNameId が有効な AbstractNetworkElement ではない場合、InstanceException がスローされます。

パラメータ

opContext:動作コンテキスト

neIds:FabricPath 競合ポート情報が照会されるネットワーク要素の InstanceNameId。

戻り値

SwitchedNetworkInterface オブジェクトのリスト。

戻されたリストには、次のインスタンスのリストが含まれています。

SwitchedNetworkInterface SwitchedNetworkInterface には、同じスイッチ ID を持つデバイス間で競合を引き起こしているポートの情報が含まれる FabricPathConflictStatus FabricPathConflictStatus が含まれます。

getFabricPathSettingsInNetworkElements

特定のネットワーク要素のすべての FabricPath 設定を戻します。

InstanceException は、渡された引数 InstanceNameId がヌルまたは空である場合、またはコレクション内の要素が有効なネットワーク要素 InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト。

neIds:FabricPath 設定情報が照会されるネットワーク要素の InstanceNameId。

戻り値

FabricPathSetting オブジェクトのリスト。

戻されたリストには、次のインスタンスのリストが含まれています。

FabricPathSetting:FabricPathSetting には、読み込まれたスイッチの SwitchId、グレースフルマージ値(イネーブルまたはディセーブル)、FabricPathTimerSetting、FabricPathSwitchStatus、FabricPathSwitchIdCnflctStatus が含まれます。

FabricPathTimerSetting:FabricPathTimerSetting には、読み込まれたさまざまなタイマー間隔が含まれます。

FabricPathSwitchStatus:FabricPathSwitchStatus には、SwitchIds および SwitchIds のステータスが含まれます。

FabricPathSwitchIdCnflctStatus:FabricPathSwitchIdCnflctStatus には、同じスイッチ ID を持つシステム ID のコレクションが含まれます。

getFabricPathTopologySettingsInNetworkElements

ネットワーク要素に対応する FabricPathTopologySetting 情報を戻します。この FabricPathTopologySetting には、FabricPathTopologySetting のコレクションが含まれます。これには、FTAG id、graphType、graphType のステータス、FabricPath Resources Conflicted TopologyId の情報が含まれます。

渡された引数 InstanceNameId InstanceNameId が有効なネットワーク要素 AbstractNetworkElement ではない場合、InstanceException がスローされます。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:L2TopologySetting 情報が照会されるネットワーク要素の InstanceNameId。

戻り値

FabricPathTopologySetting オブジェクトのリスト。

戻されたリストには、次のインスタンスのリストが含まれています。

FabricPathTopologySetting FabricPathTopologySetting には、照会されるネットワーク要素の L2IsisFtagStatus L2IsisFtagStatus コレクションが含まれます。

modifyFabricPathSettings

FabricPathSetting オブジェクトのコレクションを変更します。modifyFabricPathSettings は、コレクションに一意の要素があるかどうかを確認します。FabricPathSetting オブジェクトで、特定の任意の値がヌルと指定された場合、特定のタイマー値だけがデフォルトに設定されます。

ValidationException は、次のいずれかの状況が発生した場合にスローされます。

modifiedRscrSettingCol がヌル、または空の場合。

特定の CollectionInfo がデバイスに存在しない場合、PropertiesException がスローされます。

プラットフォーム タイプに基づいて、FabricPathSetting オブジェクトの modifiedFabricPathSettingCol のアトリビュートが有効ではない場合やサポートされていない場合。

IntegrityException は、次のいずれかの状況が発生した場合にスローされます。

modifiedFabricPathSettingCol FabricPathSetting のコレクションにあるオブジェクトの対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト。

modifiedFabricPathTimerSettingCol:FabricPathTimerSetting オブジェクトのタイマー設定の変更されたコレクション。

戻り値

void

performFabricPathForceLinkBringupInNetworkElements

デバイスで FabricPath 強制リンク起動を実行します。

渡された引数 InstanceNameId InstanceNameId が有効なネットワーク要素 AbstractNetworkElement ではない場合、InstanceException がスローされます。

パラメータ

opContext:動作コンテキスト。

neIds:FabricPath 強制リンク起動を実行する必要があるネットワーク要素の InstanceNameId のリスト。

戻り値

void