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

目次

ConfigArchiveApp サービス

ConfigArchiveApp サービスについて

createConfigArchiveTask

deleteConfigArchiveStatusHistoryTillDateForTask

deleteConfigArchiveTasks

deleteConfigFiles

deleteConfigFilesTillDate

deleteRollbackStatusHistoryTillDateForDevice

fetchCfgDiff

fetchNetworkElementConfigData

getAllConfigTasks

getAllConfigTasksInNetworkElements

getArchivalDeviceStatusEntries

getArchivedNetworkElementConfigData

getConfigArchiveSettings

getConfigArchiveStatusHistoryForTask

getConfigVersions

getRollbackStatusHistoryForDevice

modifyConfigArchiveSettings

modifyConfigArchiveTask

modifyConfigVersion

performConfigArchive

performRollback

startConfigArchiveTask

stopConfigArchiveTask

ConfigArchiveApp サービス

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

ConfigArchiveApp サービスについて

ConfigArchive コンポーネントでは、各デバイスにおける設定のアーカイブと復元操作を扱うことができます。設定アーカイバでは、ネットワークのモニタ対象 Cisco NX-OS デバイスを定期的にポーリングし、そのデバイスの実行コンフィギュレーションとスタートアップ コンフィギュレーションをアーカイブすることを目的としています。その結果、以前の設定が保存されていれば、以前の設定をリロードできます。設定が保存されていなければ、サービスを回復する前に、設定を再作成したり、再構成したりする必要があります。

ConfigArchive アプリケーションを使用すると、以下の操作を実行できます。

スケジュール設定された間隔または時間に従って、デバイスのすべての設定変更を追跡する。

設定の変更時を追跡する。

設定アーカイブ履歴を取得する。

履歴をロールバックするか、特定のバージョンにロールバックする。

設定アーカイブの時刻をスケジュール設定する。

特定のデバイスの特定のバージョンの未加工の設定データを取得する。

createConfigArchiveTask

この API は、設定アーカイブを受け取り、スケジュールに従って設定アーカイブ タスクを作成および開始します。この設定タスクは、スケジューリング タスクに組み込むデバイス インスタンス名 ID のリストを含んでいます。スケジュールは、定期スケジュールと Cron スケジュールのいずれかにすることができます。

パラメータ

opContext:動作コンテキスト

List:設定アーカイブ タスクに含めるデバイスのリスト。

schedule:定期的スケジュールまたは常時スケジュール。設定アーカイブ サービスは、このスケジュールに従ってアーカイブ プロセスを開始します。

戻り値

void

deleteConfigArchiveStatusHistoryTillDateForTask

指定したタスクの指定した日付まで設定アーカイブ ステータス履歴を削除する場合に、この API を使用します。

パラメータ

opContext:動作コンテキスト

instanceId:設定アーカイブ タスクの InstanceNameId。

timestamp:削除範囲の上限を指定するタイムスタンプ。

戻り値

void

deleteConfigArchiveTasks

既存の設定アーカイブ タスクを削除する場合に、この API を使用します。

パラメータ

opContext:動作コンテキスト

InstanceIdList:削除する必要のあるタスクのインスタンスのリスト。

戻り値

void

deleteConfigFiles

選択されたコンフィギュレーション ファイルを削除します。アーカイブされたコンフィギュレーション ファイルとデータベース メタデータの両方が削除されます。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

opContext:動作コンテキスト

InstanceIdList:削除する必要のあるタスクのインスタンスのリスト。

戻り値

void

deleteConfigFilesTillDate

指定した日付までコンフィギュレーション ファイルを削除する場合に、この API を使用します。アーカイブされたコンフィギュレーション ファイルとデータベース メタデータの両方が削除されます。

パラメータ

opContext:動作コンテキスト

vdcInstanceIdList:コンフィギュレーション ファイルを削除する必要のある VDC のインスタンス ID のリスト。

timestamp:削除範囲の上限を指定するタイムスタンプ。

戻り値

void

deleteRollbackStatusHistoryTillDateForDevice

リストで指定した VDC の指定した日付まで、ロールバック ステータス履歴を削除する場合に、この API を使用します。

パラメータ

opContext:動作コンテキスト

timestamp:削除範囲の上限を指定するタイムスタンプ。

戻り値

void

fetchCfgDiff

アーカイブされたコンフィギュレーション ファイルと現行の(スタートアップおよび実行)設定データのうち任意の 2 つのコンフィギュレーション ファイル間における diffConfig コマンドを取得する場合に、この API を使用します。この API では、まず、左方のデバイスのコンフィギュレーション ファイルを取得します。このとき、lVer がヌルであれば現行データを取得し、ヌルでなければ該当するバージョンのコンフィギュレーション ファイルを取得します。同様にして、第 2 のコンフィギュレーション ファイルを、デバイスまたは設定バージョンから取得します。

パラメータ

opContext:動作コンテキスト

lvdcInstanceId:左方で選択するデバイスのインスタンス名 ID。

lVer:左方で選択するデバイスのコンフィギュレーション ファイルのバージョン。ヌルの場合は、現在のデータであると見なされます。

lType:コンフィギュレーション ファイルのタイプ。STARTUP または RUNNING。ヌルの場合、左方で選択するデバイスについては RUNNING コンフィギュレーションであると見なされます。

rvdcInstanceId:右方で選択するデバイスのインスタンス名 ID。

rVer:右方で選択するデバイスのコンフィギュレーション ファイルのバージョン。ヌルの場合は、現在のデータであると見なされます。

rType:コンフィギュレーション ファイルのタイプ。STARTUP または RUNNING。ヌルの場合、右方で選択するデバイスについては RUNNING コンフィギュレーションであると見なされます。

戻り値

指定された左方のファイル バージョン(lVer)と右方のファイル バージョン(rVer)のコンフィギュレーション コマンド オブジェクト コレクションのコレクションを戻します。このコンフィギュレーション コマンド オブジェクトは、いずれかのバージョン ファイルに対するマッピングされたコンフィギュレーション コマンド オブジェクトの情報を含みます。

fetchNetworkElementConfigData

リストで指定した VDC の現在の設定データを取得する場合に、この API を使用します。この設定データはアーカイブされません。

パラメータ

opContext:動作コンテキスト。

vdcInstanceIdList:設定データを取得する必要のある VDC の instanceNameId のリスト。

type:

戻り値

getAllConfigTasks

この API はデータベースに作成されているすべての設定アーカイブ タスクを取得します。設定アーカイブ タスクはアクティブ状態と非アクティブ状態のいずれでもかまいません。各設定アーカイブ タスクは 1 つまたは複数のデバイスと関連できます。

パラメータ

opContext:動作コンテキスト

戻り値

getAllConfigTasksInNetworkElements

この API は、データベースに作成されており、リストで指定したネットワーク要素に関連付けられているすべての設定アーカイブ タスクを取得します。設定アーカイブ タスクはアクティブ状態と非アクティブ状態のいずれでもかまいません。各設定アーカイブ タスクは 1 つまたは複数のデバイスと関連できます。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

op:動作コンテキスト。

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

戻り値

渡されたネットワーク要素のリストに含まれている、少なくとも 1 つのデバイスに関連している ConfigArchive タスクのリスト

getArchivalDeviceStatusEntries

デバイスの instanceNameId を指定して、各デバイスのアーカイブ ステータス情報を取得する場合に、この API を使用します。

パラメータ

vdcInstanceIdList:デバイスの instanceNameId のコレクション。

戻り値

各デバイス instanceNameId に対する DeviceStatusEntries コレクションのコレクションを戻します。

getArchivedNetworkElementConfigData

設定の実際の未加工データを取得する場合に、この API を使用します。VDC InstanceId のリストとバージョンのリストを受け取り、ConfigData のリストを戻します。ConfigData には、データが圧縮形式で含まれています。ConfigData の getText() メソッドは未圧縮形式のデータを戻します。VDC インスタンス ID とバージョンの間は 1 対 1 のマッピングになります。

パラメータ

opContext:動作コンテキスト

vdcInstanceIdList:設定データを取得する必要のある VDC instanceid のリスト。

versionList:VDC に対するバージョン マッピングのリスト。

戻り値

getConfigArchiveSettings

グローバル設定アーカイブ設定を取得する場合に、この API を使用します。設定アーカイブ設定には、戻り値にする最大バージョン数および最大ステータス履歴数が含まれています。

パラメータ

opContext:動作コンテキスト

戻り値

statusHistoryCount および maxVersionCount を含んでいる ConfigArchiveSettings

getConfigArchiveStatusHistoryForTask

タスクを指定して ConfigArchiveStatus 履歴を取得する場合に、この API を使用します。データベースから。

パラメータ

opContext:動作コンテキスト

InstanceNameId:設定アーカイブ ステータス履歴を取得する必要のあるタスクの InstanceNameId。

戻り値

ConfigFetchHistory タイプのリスト。ConfigFetchHistory には、設定アーカイブ操作に関する情報、タイムスタンプ、およびデバイスのリストが含まれています。

getConfigVersions

リストで渡した VDC インスタンス ID の ConfigHistoryMetadata を取得する場合に、この API を使用します。スタートアップ コンフィギュレーションと実行コンフィギュレーションのいずれを要求しているのかを API で検査するために、設定タイプもパラメータとして渡します。

パラメータ

opContext:動作コンテキスト

vdcInstanceId:設定メタデータを取得する VDC の vdcInstanceIdList の instanceNameId。

type:設定のタイプ。設定タイプにできるのは、実行およびスタートアップです。

戻り値

各設定バージョンのメタデータのリストを戻します。

getRollbackStatusHistoryForDevice

指定したデバイスの RollbackStatusHistory をデータベースから取得する場合に、この API を使用します。

パラメータ

opContext:動作コンテキスト

vdcInstanceIdList:ロールバック ステータス履歴を取得する必要のある VDC の instanceNameId のリスト。

戻り値

RollbackHistory タイプのリスト。RollbackHistory には、ロールバックが実行されたデバイス instanceNameId に関する情報が含まれています。タイムスタンプ、結果、および結果の説明。

modifyConfigArchiveSettings

設定アーカイブ設定の値を変更する場合に、この API を使用します。

パラメータ

opContext:動作コンテキスト

setting:変更済み設定アーカイブ設定。

戻り値

void

modifyConfigArchiveTask

既存の設定アーカイブ タスクを変更する場合に、この API を使用します。ユーザは、既存タスクに対する新規デバイスの追加や既存デバイスの削除、または既存の変更済みスケジュールの変更を行うことができます。

パラメータ

opContext:動作コンテキスト

taskId:スケジュールまたはデバイスを変更するタスクの taskId。

deviceIdList:新規デバイス ID リスト。

sch:新規スケジュール。

戻り値

void

modifyConfigVersion

POJO 形式の新規コメントで既存の設定バージョンを変更する場合に、この API を使用します。

パラメータ

opContext:動作コンテキスト

configVersionList:変更する必要のある configVersion のリスト。

戻り値

void

performConfigArchive

リストで指定した VDC に対するオンデマンド設定アーカイブ操作を実行する場合に、この API を使用します。

パラメータ

opContext:動作コンテキスト

vdcInstanceIdList:設定アーカイブ操作を削除する必要のある VDC の instanceNameId のリスト。

type:実行コンフィギュレーションまたはスタートアップ コンフィギュレーションを指定するタイプ。

戻り値

void

performRollback

この API は、特定の VDC インスタンス ID に対する設定のバージョンおよびタイプを受け取り、デバイスでロールバック操作を実行します。

パラメータ

opContext:動作コンテキスト

vdcInstanceId:ロールバックする VDC の instanceNameId。

type:設定のタイプ。設定タイプにできるのは、実行およびスタートアップです。

Version:ロールバック操作を実行するコンフィギュレーション ファイルのバージョン。* @param saveToStartup は、実行コンフィギュレーションをスタートアップ コンフィギュレーションに保存する必要があるかどうかを示すブールです。

戻り値

void

startConfigArchiveTask

事前に中断されている設定アーカイブ タスクを開始する場合に、この API を使用します。VdcInstanceNameId がヌルの場合は、タスクに関連するすべてのネットワーク要素でタスクが再開されます。ヌルではない場合は、指定した VDC のジョブだけが開始されます。

パラメータ

opContext:動作コンテキスト。

taskInstanceNameId:開始する必要のあるタスクの instanceNameId。

vdcInstanceNameId:ジョブを開始する必要のある VdcInstanceNameId。

戻り値

void

stopConfigArchiveTask

実行中の設定アーカイブ タスクを停止する場合に、この API を使用します。VdcInstanceNameId がヌルの場合は、タスクに関連するすべてのネットワーク要素でタスクが停止されます。ヌルではない場合は、指定した VDC のジョブだけが停止されます。

パラメータ

opContext:動作コンテキスト。

taskInstanceNameId:停止する必要のあるタスクの instanceNameId。

vdcInstanceNameId:ジョブを停止する必要のある VdcInstanceNameId。

戻り値

void