Cisco DCNM Web サービス API ガイド リリース 5.1(1a)

ConfigDeliveryApp サービス

---

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

Config DeliveryApp サービスについて

このアプリケーション インターフェイスでは、DCNM 設定配信コンポーネントに備わっているサービスを宣言します。

bindTargetDeviceDetails

指定されたターゲット デバイスを指定された設定配信タスク オブジェクトとバインドします。

パラメータ

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

configDeliveryTaskId：指定したターゲット デバイスをバインドする必要のある設定配信タスク。

details：バインドするターゲット デバイス。

戻り値

void

cancelConfigDeliveryTasks

このメソッドは、指定された設定配信タスクのうち、進行中のすべてのタスクをキャンセルします。

この操作では、完了したタスクは無視されます。

パラメータ

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

taskIds：キャンセルする設定配信タスクの InstanceNameId のリスト。

戻り値

void

createConfigDeliveryTask

このメソッドは、指定された設定配信タスクをサーバに作成し、新規作成した設定配信タスク オブジェクトの InstanceNameId を戻します。

パラメータ

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

task：作成する新規設定配信タスク。

戻り値

新規オブジェクトの InstanceNameId。

createConfigDeliveryTasks

このメソッドは、指定された設定配信タスクをサーバに作成し、新規作成した設定配信タスク オブジェクトの InstanceNameId を戻します。

パラメータ

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

task：作成する新規設定配信タスク。

戻り値

新規オブジェクトの InstanceNameId。

deleteConfigDeliveryTasks

このメソッドは、指定されたすべての設定配信タスクをサーバから削除します。

パラメータ

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

taskIds：削除する設定配信タスクの InstanceNameId のリスト。

戻り値

void

deliverConfiguration

指定されたロー CLI コマンドを指定されたデバイスに配信します。

パラメータ

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

neId：コマンドを配信するネットワーク要素の InstanceNameId。

commands：配信するコマンドのリスト。

processExitCommands：スペースに基づいてコマンドを自動終了させる、指定したコマンドに先行する追加のコマンドをイネーブルにするブール フラグ。

戻り値

void

fetchNetworkElementCommandResponse

このメソッドは指定されたデバイスで指定されたコマンドを起動し、デバイスの応答を戻します。

パラメータ

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

neId：応答が必要なネットワーク要素の InstanceNameId。

command：指定したデバイスで実行するコマンド。

戻り値

指定したコマンドに対するデバイスの応答。

fetchNetworkElementCommandResponses

このメソッドは指定されたデバイスで指定された複数のコマンドを起動し、デバイスの複数の応答を戻します。

パラメータ

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

neId：応答が必要なネットワーク要素の InstanceNameId。

commands：指定したデバイスで実行するコマンドのリスト。

戻り値

指定したコマンドに対するデバイスの応答。

getAllConfigDeliveryTasks

このメソッドは、サーバに備わっているすべての設定配信タスクを戻します。

パラメータ

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

戻り値

ConfigDeliveryTask インスタンスとして表されたすべての設定配信タスク。

getAllTemplates

このメソッドは、DCNM サーバに定義されているすべてのテンプレートを戻します。

パラメータ

opContext：API コールの動作コンテキスト。

戻り値

サーバに定義されているすべてのテンプレートのリスト。

getConfigDeliveryTask

このメソッドは、指定されたインスタンス クラス ID の設定配信タスクを戻します。

パラメータ

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

taskId：必要な設定配信タスクの InsanceNameId。

戻り値

設定配信タスク。

getTargetDeviceDetails

このメソッドは、指定された設定配信タスクで選択されたターゲット デバイスごとにデバイス レベル ステータス情報を戻します。

パラメータ

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

taskId：詳細ステータスが必要な設定配信タスクの InstanceNameId。

戻り値

ConfigDeliveryTaskDeviceDetails インスタンスのリストとして表されたデバイス レベル ステータス。

modifyConfigDeliveryTask

指定された変更された設定配信タスクをサーバで更新します。

このメソッドは、指定された設定配信タスク オブジェクトでの変更のうち、ターゲット デバイス アソシエーション コレクションの ConfigDeliveryTask.getConfigDeliveryTaskDeviceDetailsCol() に対する変更を除くすべての変更を更新します。

パラメータ

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

task：変更された設定配信タスク。

戻り値

void

modifyConfigDeliveryTaskDeviceDetails

指定された設定タスク デバイス詳細オブジェクトをサーバで変更します。

パラメータ

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

details：更新する必要のある設定タスク デバイス詳細オブジェクト。

戻り値

void

performCopyRunToStart

「copy running-config startup-config」コマンドを配信する新規設定配信タスクを、リストで指定されたデバイスに作成し、新規作成した設定配信タスク オブジェクトの InstanceNameId を戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

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

neInstanceNameIdCol：コマンドを配信する必要のあるネットワーク要素の InstanceNameId のリスト

isForAllVdcs：すべての VDC に対してスタートアップに対する実行のコピーを起動する必要があるかどうかを決めるブール フラグ

bootflashFileName：実行コンフィギュレーションのコピー先として使用する必要のあるファイルの名前を指定します。「null」を指定した場合、実行コンフィギュレーションがスタートアップ コンフィギュレーションにコピーされます。

戻り値

新規設定配信タスク オブジェクトの InstanceNameId。

unbindTargetDeviceDetails

指定されたターゲット デバイスを指定された設定配信タスク オブジェクトからアンバインドします。

パラメータ

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

configDeliveryTaskId：指定したターゲット デバイスをアンバインドする必要のある設定配信タスク。

details：アンバインドする必要のあるターゲット デバイス。

戻り値

void