ServerApp サービス
この章では、DCNM Web サービスの、ServerApp サービスに対応する API メソッドについて説明します。この API は、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。
ServerApp サービスについて
このインターフェイスは、ServerApp によって公開されるすべての API を定義します。
bindComputerSystems
InstanceNameId のリストに対応する NetworkInterface のリストを、対応するサーバ名にバインドします。
パラメータ
opContext:動作コンテキスト。
niInstanceNameId:NetworkInterface の InstanceNameId のリスト。
csNameList:指定した NetworkInterface のリストにバインドする必要のあるサーバ名の文字列のリスト。
戻り値
void
createComputerSystems
指定された IP アドレスまたはホスト名に対応する抽象コンピュータ システムのリストを作成します。
パラメータ
opContext:動作コンテキスト
neCo:追加する抽象コンピュータ システムに対応する ID のリスト。
戻り値
AbstractComputerSystem のリスト。
createComputerSystemRanges
コンピュータ システム範囲を作成します。
パラメータ
opContext:動作コンテキスト。
computerSystemRangeCol:コンピュータ システム範囲カラム。
戻り値
void
createComputerSystemsWithCredentials
資格情報付きでコンピュータ システムを作成します。
パラメータ
opContext:動作コンテキスト。
neCo:ne カラム。
credentials:コンピュータ システムの資格情報
戻り値
void
deleteComputerSystems
渡された InstanceNameId を持つ AbstractComputerSystem を削除します。
パラメータ
opContext:動作コンテキスト。
戻り値
void
deleteComputerSystemRanges
コンピュータ システム範囲を削除します。
パラメータ
opContext:動作コンテキスト。
computerSystemRangeCol:コンピュータ システム範囲カラム
戻り値
void
getAllComputerSystems
InstanceNameId のリストに対応する AbstractComputerSystem のリストを戻します。
パラメータ
opContext:動作コンテキスト
acsInstanceNameIdList:取得する必要のある AbstractComputerSystem に対応する instanceID のリスト。
戻り値
AbstractComputerSystem のリスト。戻されるリストには、次のアソシエーションが含まれています。
• AbstractComputerSystem に対応する AbstractComputerSystemStatus。
• AbstractComputerSystem に関連付けられている NetworkInterface のリスト。
getAllComputerSystemRanges
すべてのコンピュータ システム範囲を取得します。
パラメータ
opContext:動作コンテキスト
戻り値
コンピュータ システム範囲のリスト。
getComputerSystemsForGivenMac
指定された MAC アドレスのリストに対応する AbstractComputerSystem のリストを戻します。
パラメータ
opContext:動作コンテキスト
macList:取得する必要のあるサーバ ポートの MAC アドレスに対応する文字列のリスト。
戻り値
AbstractComputerSystem のリスト。戻されるリストには、次のアソシエーションが含まれています。
• AbstractComputerSystem に対応する AbstractComputerSystemStatus。
• AbstractComputerSystem に関連付けられている NetworkInterface のリスト。
getComputerSystemsForGivenNameOrIp
指定された名前または IP アドレスのリストに対応する AbstractComputerSystem のリストを戻します。
パラメータ
opContext:動作コンテキスト
nameOrIpList:取得する必要のあるサーバの IP アドレスまたは名前に対応する文字列のリスト。
exactMatch:このパラメータが true に設定されている場合は、渡された名前または IP アドレスと完全に一致するサーバを戻します。false の場合は、名前または IP アドレスが nameOrIpList で渡された文字列と一致するすべてのサーバを戻します。この機能により、regex による照合をサポートできます。
戻り値
AbstractComputerSystem のリスト。戻されるリストには、次のアソシエーションが含まれています。
• AbstractComputerSystem に対応する AbstractComputerSystemStatus。
• AbstractComputerSystem に関連付けられている NetworkInterface のリスト。
getAllComputerSystemsInstanceNameIds
ネットワーク内の AbstractComputerSystem の InstanceNameId のリストを戻します。
パラメータ
opContext:動作コンテキスト
戻り値
AbstractComputerSystem の InstanceNameId のリスト。
getAllUncorrelatedComputerSystems
FC 検出の一部として検出されており、InstanceNameId のリストに対応している、ネットワーク内の AbstractComputerSystem のリストを戻します。
パラメータ
opContext:動作コンテキスト
acsInstanceNameIdList:取得する必要のある AbstractComputerSystem に対応する InstanceNameId のリスト。
戻り値
AbstractComputerSystem のリスト。
getAllUncorrelatedComputerSystemsInstanceNameIds
FC 検出の一部として検出された、ネットワーク内の AbstractComputerSystem の InstanceNameId のリストを戻します。
パラメータ
opContext:動作コンテキスト
戻り値
AbstractComputerSystem の InstanceNameId のリスト。
getAllVirtualComputerSystems
指定された InstanceNameId に対応する VirtualComputerSystem のリストを戻します。
パラメータ
opContext:動作コンテキスト
vcsInstanceNameIdList:取得する必要のある VirtualComputerSystem に対応する InstanceNameId のリスト。
戻り値
VirtualComputerSystem のリスト。戻されるコレクションには、次のアソシエーションが含まれています。
• VirtualComputerSystem に対応する AbstractComputerSystemStatus
• VirtualComputerSystem に関連付けられている NetworkInterface のリスト。
getComputerSystemNeighbors
AbstractComputerSystem のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• 渡された引数がヌルの場合
• neInstanceNameIds が AbstractNetworkElement の有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
neInstanceNameIds:ネットワーク要素のインスタンス名 ID。
戻り値
AbstractComputerSystem のリスト。戻されるコレクションには、次のアソシエーションが含まれています。
• AbstractComputerSystem に対応する AbstractComputerSystemStatus
• ComputerSystem に対応する ComputerSystemChassis
• AbstractComputerSystem に関連付けられている NetworkInterface のリスト
• EndDeviceType JBOD タイプの ComputerSystem と関連付けられている VirtualComputerSystem のリスト
getComputerSystemNeighborsWithLinks
AbstractComputerSystem のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• 渡された引数がヌルの場合
• neInstanceNameIds が AbstractNetworkElement の有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
neInstanceNameIds:ネットワーク要素インスタンス名 ID。
戻り値
AbstractComputerSystem のリスト。戻されるコレクションには、次のアソシエーションが含まれています。
• AbstractComputerSystem に対応する AbstractComputerSystemStatus
• ComputerSystem に対応する ComputerSystemChassis
• AbstractComputerSystem に関連付けられている NetworkInterface のリスト
• EndDeviceType JBOD タイプの ComputerSystem と関連付けられている VirtualComputerSystem のリスト
getDefaultComputerSystemCredentials
リンク付きで ComputerSystemCredential のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• 渡された引数がヌルの場合
• neInstanceNameIds が AbstractNetworkElement の有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
neInstanceNameIds:ネットワーク要素インスタンス名 ID。
戻り値
AbstractComputerSystem のリスト。戻されるコレクションには、次のアソシエーションが含まれています。
• AbstractComputerSystem に対応する AbstractComputerSystemStatus
• ComputerSystem に対応する ComputerSystemChassis
• AbstractComputerSystem に関連付けられている NetworkInterface のリスト
• EndDeviceType JBOD タイプの ComputerSystem と関連付けられている VirtualComputerSystem のリスト
getUpstreamSwitches
AbstractNetworkElement のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• 渡された引数がヌルの場合
• neInstanceNameIds が AbstractNetworkElement の有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
acsInstanceNameIds:AbstractComputerSystem の InstanceNameId。
戻り値
hostName および mgmtIpAddress が読み込まれている場合に限り、AbstractNetworkElement のリスト。
getUserCredentialsForComputerSystems
現在のアプリケーション ユーザのデフォルト コンピュータ システム資格情報として、指定された資格情報を設定します。
パラメータ
opContext:動作コンテキスト。
cred:デフォルト資格情報として使用する ComputerSystemCredential オブジェクト。
戻り値
void
modifyComputerSystemRanges
コンピュータ システム範囲を変更します。
パラメータ
opContext:動作コンテキスト。
computerSystemRangeCol:コンピュータ システム範囲カラム。
戻り値
void
modifyDefaultComputerSystemCredentials
現在のアプリケーション ユーザのデフォルト コンピュータ システム資格情報として、指定された資格情報を設定します。
パラメータ
opContext:動作コンテキスト。
cred:デフォルト資格情報として使用する ComputerSystemCredential オブジェクト。
戻り値
void
modifyUserCredentialsForComputerSystems
1 つまたは複数の抽象コンピュータ システム オブジェクトについて、アプリケーション ユーザの資格情報を変更します。
パラメータ
opContext:動作コンテキスト。
appUserInstanceNameId:ApplicationUser オブジェクトの InstanceNameId。
acsInstanceNameIdCol:AbstractComputerSystem オブジェクトの InstanceNameId を 1 つまたは複数含むコレクション。
cred:指定されたコンピュータ システムでアプリケーション ユーザの検証に使用する必要のある ComputerSystemCredential オブジェクト。
戻り値
void
performComputerSystemCorrelation
コンピュータ システム相関を実行し、対応するコンピュータ システムにアダプタをマッピングします。
パラメータ
opContext:動作コンテキスト
acsInstanceNameIdList:自動相関を実行する必要のある AbstractComputerSystem の InstanceNameId のリスト。
戻り値
void
unbindComputerSystems
InstanceNameId のリストに対応する NetworkInterface のリストからサーバ名をアンバインドします。
パラメータ
opContext:動作コンテキスト
niInstanceNameId:NetworkInterface の InstanceNameId のリスト。
戻り値
void