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

目次

ImageInstallApp サービス

ImageInstallApp サービスについて

abortJob

abortTask

createJob

deleteJob

fetchDiskFreeSpace

fetchDiskFreeSpaceFromStandbySup

getAllInstallTasks

getAllInstallTasksInNetworkElements

getAllJobs

getFailureLog

getJob

getStatusOfJobInNetworkElement

modifyJob

performVersionCompatability

resumeJob

suspendJob

ImageInstallApp サービス

この章では、DCNM Web サービスの、ImageInstallApp サービスに対応する API メソッドについて説明します。

ImageInstallApp サービスについて

ImageManagement コンポーネントを使用すると、中断なしモード(デュアル スーパーバイザ デバイス)または中断ありモード(シングル スーパーバイザ デバイス)でデバイスを更新できます。ImageInstallJob は、複数の ImageInstallTask を含む場合があります。1 つの ImageInstallTask は、ジョブ内の 1 つのデバイスに対応します。デバイスがサーバから削除されると、それに対応するすべてのタスクが削除されます。ImageInstallApp インターフェイスは、イメージのアップグレード処理を行うさまざまな API を定義します。

abortJob

この API は、ジョブの実行前にイメージのアップグレードがスケジュールされているジョブを中断(削除)するために使用されます。

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

jobIdList コレクションがヌル、または空の場合。

jobIdList コレクションにタイプ ImageInstallJob InstanceNameId ではない要素が含まれている場合。

jobIdList コレクションに、データベースに存在しない ImageInstallJob が含まれている場合。

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

ユーザが現在実行中の ImageInstallJob オブジェクトを中断しようとしている場合

パラメータ

opContext:動作コンテキスト

jobIdList:ユーザが中断しようとしているジョブ情報のリスト。

戻り値

void

abortTask

この API は、選択したインストール タスクをジョブから中断するために使用されます(1 つのジョブに複数のタスクが含まれる場合があります)。

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

installTaskCol コレクションがヌル、または空の場合。

installTaskCol コレクションにタイプ ImageInstallTask InstanceNameId ではない要素が含まれている場合。

installTaskCol コレクションに、データベースに存在しない ImageInstallTask が含まれている場合。

パラメータ

opContext:動作コンテキスト

installTaskCol:ユーザがジョブから中断しようとしているタスクのリスト。

戻り値

void

createJob

この API は、新しいジョブのイメージ アップグレードのスケジュールを設定するために使用されます。jobInstance を作成します。ジョブは、ImageInstallTask アソシエーションなしでは作成できません。1 つの ImageInstallJob には複数の ImageInstallTask が含まれている場合があります。1 つの ImageInstallTask は、ジョブ内の 1 つのデバイスに対応します。

特定の ImageInstallJob に対して、以下のアソシエーションが用意されています。

1. 指定した ImageInstallJob ImageInstallTask 参照に対応する ImageInstallTaskReference

2. 指定した ImageInstallTask AbstractNetworkElement 参照に対応する AbstractNetworkElementReference

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

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

newJobInfoCol 内の要素が有効なタイプの ImageInstallJOb でない、または ImageInstallTask 参照が指定されていない場合。

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

同じ jobId のジョブがすでに存在する場合。

パラメータ

opContext:動作コンテキスト

newJobInfoCol:作成する ImageInstallJob オブジェクトのリスト。

戻り値

新しく作成される ImageInstallJob に対応する InstanceNameId のリスト。

deleteJob

この API は、スケジュールされたジョブを削除するために使用されます。特定の InstanceNameId のリストに対応するジョブ オブジェクトを削除します。対応する ImageInstallJob およびそのアソシエーションが削除されます。

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

jobIdList コレクションがヌル、または空の場合。

jobIdList コレクションにタイプ ImageInstallJob InstanceNameId ではない要素が含まれている場合。

jobIdList コレクションに、データベースに存在しない ImageInstallJob が含まれている場合。

ユーザが現在実行中のジョブを削除しようとしている場合

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

ユーザが現在実行中の ImageInstallJob オブジェクトを削除しようとしている場合。

パラメータ

opContext:動作コンテキスト

jobIdList:削除するジョブのリスト。

戻り値

void

fetchDiskFreeSpace

この API は、ブートフラッシュの使用可能なディスク領域を識別するために使用されます。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:特定のネットワーク要素の InstanceNameId。

戻り値

使用可能なディスク領域をリストします。

fetchDiskFreeSpaceFromStandbySup

この API は、ブートフラッシュのスタンバイとして使用可能なディスク領域を識別するために使用されます。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:特定のネットワーク要素の InstanceNameId。

戻り値

特定のデバイスの使用可能なディスク領域をリストします。

getAllInstallTasks

この API は、特定のネットワーク要素のすべての ImageInstalltionTask オブジェクトを取得するために使用されます。ネットワーク要素に対してヌルが渡された場合、InstanceNameId はすべての ImageInstallTask オブジェクトのリストを戻します。

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

neInstanceNameId が AbstractNetworkElement の InstanceNameId ではない場合。

neInstanceNameId の対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

戻り値

installTasks のリスト。

getAllInstallTasksInNetworkElements

この API は、特定のネットワーク要素のリストに対するすべての ImageInstalltionTask オブジェクトを取得するために使用されます。

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

neInstanceNameId が AbstractNetworkElement の InstanceNameId ではない場合。

neInstanceNameId の対応するオブジェクトが存在しない場合。

パラメータ

opContext:この API コールの動作コンテキスト

neInstanceNameIdCol:ネットワーク要素の InstanceNameId のリスト

戻り値

特定のネットワーク要素に対応する installTasks のリストのリスト。

getAllJobs

この API は、パラメータとして渡された状態に対応する ImageInstallJob オブジェクトを取得するために使用されます。渡された状態がヌルの場合、すべての ImageInstalljob オブジェクトが状態にかかわらず戻されます。

パラメータ

opContext:動作コンテキスト

aInstallationStatus:ユーザが jobInfo のリストを必要としている状態を表し、以下のいずれかになります。1)InstallationStatus.COMPLETED は、すべての完了したジョブのリストを戻します。2)InstallationStatus.RUNNING は、すべてのアクティブなジョブのリストを戻します。3)InstallationStatus.SCHEDULED は、すべての保留中のジョブのリストを戻します。

戻り値

指定した状態タイプのすべての installJobs をリストします。

getFailureLog

ジョブ コレクションのエラー ログを戻します。

パラメータ

opContext:動作コンテキスト

jobCol:ジョブの InstanceNameId のリスト。

戻り値

エラー ログのリスト。

getJob

この API は、特定のジョブおよび対応するタスクの詳細を取得するために使用されます。

パラメータ

opContext:動作コンテキスト

jobNameId:ジョブの InstanceNameId

戻り値

ImageInstallJob 固有の(jobNameId)ジョブおよび対応するタスクの詳細。

getStatusOfJobInNetworkElement

この API は、特定のネットワーク要素の最後に完了したジョブまたは現在のジョブの状態を取得するために使用されます。特定のネットワーク要素に現在のジョブまたは最後に完了したジョブが見つからない場合、API はヌルを戻します。

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

neInstanceNameId がヌルの場合、または AbstractNetworkElement の InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:特定のネットワーク要素の InstanceNameId。

aInstallationStatus:aInstallationStatus に対してヌルが渡された場合、特定のネットワーク要素の最後に完了したジョブの状態を戻します。aInstallationStatus に対して InstallationStatus.Running が渡された場合、特定のネットワーク要素の現在のジョブ状態を戻します。

戻り値

InstallationStatus、特定のネットワーク要素の最後に完了したジョブまたは現在のジョブの状態。

modifyJob

この API は、変更されたジョブ情報を用いてスケジュールされたジョブを変更するために使用されます。ImageInstallJob インスタンスのアトリビュートを変更します。ユーザは jobId を変更できません。ユーザは、scheduleTime を更新し、また、ImageInstallTask アソシエーションを更新することができます。つまり、ユーザは特定の ImageInstallJob インスタンスから ImageInstallTask を追加または削除できます。

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

modifiedJobInfo がヌルの場合。

対応する ImageInstallJob オブジェクトに同等の永続的な IamgeInstallJob オブジェクトがない場合。

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

IamgeInstallJob のいずれのアトリビュートも有効ではない場合。

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

ユーザが現在実行中の ImageInstallJob オブジェクトを変更しようとしている場合。

パラメータ

opContext:動作コンテキスト

modifiedJobInfo:スケジュールされたジョブの modifiedInfo。

戻り値

void

performVersionCompatability

この API は、キックスタートとシステム イメージの間のバージョン互換ログ情報を取得するために使用されます。たとえば、指定したキックスタートとシステム イメージに互換性がない場合(バージョンが異なる場合)、API は以下のログ メッセージを含むログ情報を戻します。「Install has failed. Return code 0x40930024 (Images specified are not upgradeable). Please identify the cause of the failure, and try 'install all' again.」

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

neIdCol コレクションがヌル、または空の場合。

neIdCol コレクションにタイプ AbstractNetworkElement InstanceNameId ではない要素が含まれている場合。

taskCol コレクションがヌル、または空の場合。

taskCol コレクションにタイプ ImageInstallTask InstanceNameId ではない要素が含まれている場合。

jobCol コレクションがヌル、または空の場合。

jobCol コレクションにタイプ ImageInstallJob InstanceNameId ではない要素が含まれている場合。

パラメータ

opContext:動作コンテキスト

neIdCol:ネットワーク要素の InstanceNameId

taskCol:ImageInstallTask オブジェクトのコレクション

jobCol:ImageInstallJob オブジェクトのコレクション

戻り値

キックスタートとシステム イメージの両方が互換であるかどうかを指定するログ情報のリスト。

resumeJob

この API は、実行が保留になっているジョブを再開するために使用されます。

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

jobIdList コレクションがヌル、または空の場合。

jobIdList コレクションにタイプ ImageInstallJob InstanceNameId ではない要素が含まれている場合。

jobIdList コレクションに、データベースに存在しない ImageInstallJob が含まれている場合。

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

ユーザが一時停止されていない ImageInstallJob オブジェクトを再開しようとしている場合。

パラメータ

opContext:動作コンテキスト

jobIdList:ユーザが再開しようとしているジョブ情報。

戻り値

void

suspendJob

この API は、ジョブの実行を一時停止(停止)し、後で再開するために使用されます。

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

jobIdList コレクションがヌル、または空の場合。

jobIdList コレクションにタイプ ImageInstallJob InstanceNameId ではない要素が含まれている場合。

jobIdList コレクションに、データベースに存在しない ImageInstallJob が含まれている場合。

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

ユーザが現在実行中の ImageInstallJob オブジェクトを一時停止しようとしている場合。

パラメータ

opContext:動作コンテキスト

jobIdList:ユーザが一時停止しようとしているジョブ情報。

戻り値

void