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

目次

ConfigTemplateApp サービス

ConfigTemplateApp サービスについて

createTemplate

deleteTemplates

getAllTemplates

getTemplateContents

getTemplates

modifyTemplates

populateTemplateRepository

ConfigTemplateApp サービス

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

ConfigTemplateApp サービスについて

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

createTemplate

1 つまたは複数のテンプレート オブジェクトを作成します。このメソッドでは、作成するテンプレートのリストを指定すると、データベースにオブジェクトを作成し、この作成したオブジェクトの InstanceNameId を戻します。

パラメータ

opContext:動作コンテキスト

templateColConfigTemplate:テンプレート オブジェクトのリスト。

戻り値

サーバに作成されたテンプレート オブジェクトのリスト。

deleteTemplates

1 つまたは複数のテンプレート オブジェクトを削除します。指定されたテンプレート オブジェクトの InstanceNameId に基づいてテンプレート オブジェクトを削除します。

パラメータ

opContext:動作コンテキスト。

templateInstanceNameIdCol:削除する必要のある 1 つまたは複数のテンプレート オブジェクトの InstanceNameId を含んでいるコレクション。

戻り値

void

getAllTemplates

DCNM サーバに定義されているすべてのテンプレートを戻します。

パラメータ

opContext:動作コンテキスト。

templateInstanceNameIdCol:削除する必要のある 1 つまたは複数のテンプレート オブジェクトの InstanceNameId を含んでいるコレクション。

戻り値

テンプレートの内容である StringBuilder オブジェクトのリスト。

getTemplateContents

1 つまたは複数のテンプレート オブジェクトの内容を取得します。

パラメータ

opContext:動作コンテキスト。

collectionInfoId:collectionInfo の InstanceId。

戻り値

void

getTemplates

指定された InstanceNameId から設定テンプレートを戻します。ConfigTemplates の InstanceNameId のコレクションを指定すると、対応する ConfigTemplate オブジェクトを戻します。

パラメータ

opContext:動作コンテキスト。

templateInstanceNameIdCol:ConfigTemplate の InstanceNameId のコレクション。

戻り値

指定された InstanceNameId のコレクションに対応する ConfigTemplate オブジェクトのリスト。

modifyTemplates

既存の 1 つまたは複数のテンプレート オブジェクトを変更します。

パラメータ

opContext:動作コンテキスト。

templateCol:データベースにある既存のテンプレート オブジェクトを置換する Template オブジェクトのコレクション。

戻り値

void

populateTemplateRepository

共有場所でテンプレート情報をリフレッシュします。テンプレートが存在していなかった場合は、テンプレートに無効のマークを付けます。新規テンプレートを追加し、既存のテンプレートを更新します。このメソッドではイベントは生成されません。

パラメータ

opContext:動作コンテキスト。

戻り値

void