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

目次

FcApp サービス

FcApp サービスについて

addServers

deleteLogicalEndDeviceEnclosures

getAllLogicalEndDeviceEnclosures

getAllLogicalEndDeviceEnclosuresOfType

getAllLogicalEndDevices

getAllLogicalEndDevicesOfType

getAllMdsSwitches

getConnectedSwitches

getLogicalEndDeviceNeighbors

getPhysicalLinksForLogicalEndDevices

getPhysicalLinksForLogicalEndDevicesFromSource

modifyLogicalEndDevices

performEndDevicesCorrelation

FcApp サービス

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

FcApp サービスについて

このインターフェイスでは、FC 機能サービスの外観に公開されるすべての API を定義します。

addServers

デバイス リストにサーバのリストを追加します。指定した IP アドレスを持つサーバがデバイス リストにすでにある場合、このメソッドは AppException をスローします。

パラメータ

opContext:動作コンテキスト

neCol:デバイス リストに追加されるサーバに対応する識別子のリスト。

戻り値

LogicalEndDeviceEnclosure のリスト

deleteLogicalEndDeviceEnclosures

InstanceNameIds が渡された LogicalEndDeviceEnclosures を削除します。メンバー LogicalEndDevices は削除されません。

パラメータ

opContext:動作コンテキスト

戻り値

void

getAllLogicalEndDeviceEnclosures

ネットワーク内の LogicalEndDeviceEnclosures のリストを戻します。

パラメータ

opContext:動作コンテキスト

deviceType:デバイス タイプ

戻り値

LogicalEndDeviceEnclosure のリスト

getAllLogicalEndDeviceEnclosuresOfType

ネットワーク内の LogicalEndDevices のリストを戻します。EndDeviceType を指定すると、そのタイプのすべての LogicalEndDevices が戻されます。渡された EndDeviceType がヌルの場合、ネットワーク内のすべての LogicalEndDevices が戻されます。deviceType を EndDeviceType.HOST として渡し、すべての Server Enclosure を取得します。deviceType を EndDeviceType.JBOD として渡し、すべての JBOD Enclosure を取得します。

パラメータ

opContext:動作コンテキスト

deviceType:デバイス タイプ

戻り値

LogicalEndDeviceEnclosure のリスト

getAllLogicalEndDevices

ネットワーク内の LogicalEndDevice のリストを戻します。

パラメータ

opContext:動作コンテキスト。

deviceType:デバイス タイプ。

戻り値

LogicalEndDevice のリスト。

getAllLogicalEndDevicesOfType

ネットワーク内の LogicalEndDevices のリストを戻します。EndDeviceType を指定すると、そのタイプのすべての LogicalEndDevices が戻されます。

渡された EndDeviceType がヌルの場合、ネットワーク内のすべての LogicalEndDevices が戻されます。

パラメータ

opContext:動作コンテキスト

deviceType:デバイス タイプ

戻り値

LogicalEndDevice のリスト

getAllMdsSwitches

AbstractNetworkElement のリストを戻します。ネットワーク内で検出されたすべての MDS スイッチを戻します。

パラメータ

opContext:動作コンテキスト。

戻り値

AbstractNetworkElement のリスト。

getConnectedSwitches

AbstractNetworkElement のリストを戻します。LogicalEndDevice の InstanceNameId を指定すると、それに接続されているすべてのスイッチが戻されます。

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

渡された引数がヌルの場合

LogicalendDeviceInstanceNameId が LogicalEndDevice の有効な InstanceNameId ではない場合

パラメータ

opContext:動作コンテキスト

aLogicalendDeviceInstanceNameId:LogicalEndDevice の InstanceNameId

戻り値

AbstractNetworkElement のリスト

getLogicalEndDeviceNeighbors

LogicalEndDevice のリストを戻します。AbstractNetworkElement の InstanceNameId を指定すると、それに接続されているすべてのエンド デバイスが戻されます。

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

渡された引数がヌルの場合

networkElementInstanceNameIds が AbstractNetworkElement の有効な InstanceNameId ではない場合

パラメータ

opContext:動作コンテキスト

networkElementInstanceNameIds:ネットワーク要素のインスタンス名 ID

戻り値

LogicalEndDevice のリスト

getPhysicalLinksForLogicalEndDevices

論理エンド デバイスの物理リンクを取得します。

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

渡された引数がヌルの場合

ledInstanceNameIds が LogicalEndDevice の有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト。

ledInstanceNameIds:論理エンド デバイスのインスタンス名 ID

戻り値

物理エンド デバイスの物理リンク。

getPhysicalLinksForLogicalEndDevicesFromSource

送信元から論理エンド デバイスの物理リンクを取得します。

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

渡された引数がヌルの場合

ledInstanceNameIds が LogicalEndDevice の有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト。

ledInstanceNameIds:論理エンド デバイスのインスタンス名 ID

srcInstanceNameId:送信元インスタンス名 ID

戻り値

物理エンド デバイスの物理リンク。

modifyLogicalEndDevices

LogicalEndDevice を変更します。各要求のとおりに、LogicalEndDeviceEnclosure を作成、削除、および更新します。

パラメータ

opContext:動作コンテキスト

logicalEndDevices:LogicalEndDevice のリスト

戻り値

void

performEndDevicesCorrelation

エンド デバイスの相関を実行し、エンド デバイスをそれぞれのエンクロージャにマップします。

パラメータ

opContext:動作コンテキスト

serverList:自動相関を実行する必要のあるさまざまなサーバの IP アドレスまたは DNS 名のリスト。

戻り値

void