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

RepositoryApp サービス

---

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

RepositoryApp サービスについて

この章では、DCNM サーバの Repository API コンポーネントにより公開されるサービスを定義します。

abortCurrentProcess

この API は、通常、API getResultsFromConnection(OpContext, String) を呼び出して現在実行中のプロセスを停止した後で呼び出されます。getFirstLevelFileNames(OpContext, String, String, String, Boolean)、getRecursivelyFileNames(OpContext, String, String, String, Boolean) を呼び出した後でリストの最後に到達していない場合、クライアントもこの API を呼び出すことができます。この API は、ブール値（正常な中断の場合 true）を戻します。

パラメータ

opContext：動作コンテキスト

connectionId：現在のプロセスを中断する必要がある ConnectionId

戻り値

正常な中断の場合 true、その他の場合 false。

createConnection

この API は、DB にあるリポジトリとの接続を作成するときにクライアントにより使用されます。指定リポジトリ InstanceNameId との接続を作成します。一意な接続 ID 文字列を生成します。これは、各クライアント接続で一意です。クライアントは、一意な接続 ID で単一リポジトリ サーバとの複数の接続を作成できます。この connectionId をクライアントに戻します。

パラメータ

opContext：動作コンテキスト

repositoryInstanceNameId：接続が作成される必要があるリポジトリ インスタンス名。

戻り値

接続 ID をクライアントに戻します。クライアントは、新しい接続ではなく、同じリポジトリの連続する Repository API 呼び出しの同じ接続 ID を使用できます。

createConnectionWithRepSvr

この API は、ダミー ServerRepository オブジェクトを指定して一時的な接続を作成するときにクライアントにより使用されます。この API は、通常、クライアントが、前もって作成されていないリポジトリに接続するときに呼び出されます。そのため、クライアントは、この API を使用して接続を作成できます。指定 ServerRepository(rfp) 情報のリポジトリとの接続を作成します。一意な接続 ID 文字列を生成します。これは、各クライアント接続で一意です。クライアントは、一意な接続 ID で単一リポジトリ サーバとの複数の接続を作成できます。この connectionId をクライアントに戻します。

パラメータ

opContext：動作コンテキスト

rfp：接続が作成される必要があるリポジトリの情報

戻り値

接続 ID をクライアントに戻します。クライアントは、新しい接続ではなく、同じリポジトリの連続する Repository API 呼び出しの同じ接続 ID を使用できます。

createRepositoryServers

リポジトリ情報コレクションを DCNM サーバに保持して、リポジトリ サーバ コレクション自体を戻します。これは、一部のプロパティがサーバ側で操作および設定されるためです。クライアントは、これを認識しなければならない場合があります。

パラメータ

opContext：動作コンテキスト。

newRepLocationCol：保持するリポジトリ情報のコレクション。

戻り値

リポジトリ サーバ コレクションをクライアントに戻します。

deleteConnection

指定 connectionId のリポジトリ接続を DCNM サーバから接続解除して削除します。

パラメータ

opContext：動作コンテキスト

connectionId：接続を DCNM サーバから接続解除して削除する ConnectionId。

戻り値

void

deleteConnectionUseRepSvr

この API は、DCNM サーバで指定セットのサーバ リポジトリからすべての接続を接続解除および削除する場合に、クライアントにより使用されます。これは、ServerRepository 情報が変更される前に使用されます。指定リポジトリ情報のリポジトリ接続を DCNM サーバから接続解除して削除します。

パラメータ

opContext：動作コンテキスト

repositoryCol：接続を作成および接続解除する必要があるリポジトリ情報コレクション。

戻り値

void

deleteRepositoryFiles

この API は、指定リポジトリ接続の指定ファイルを削除します。

パラメータ

opContext：動作コンテキスト

connectionId：リポジトリの接続 ID

pathCol：リポジトリ（接続 connectionId を含む）で削除されるファイルのパス コレクション

戻り値

void

deleteRepositoryServers

指定 Repository instanceNameId コレクションの DCNM サーバからリポジトリ情報を削除します。

パラメータ

opContext：動作コンテキスト。

repInstanceNameIdCol：リポジトリ情報が削除されるリポジトリ インスタンス名コレクション。

戻り値

void

fetchAllRepositoryServers

すべてのリポジトリ情報をクライアントで取得します。

パラメータ

opContext：動作コンテキスト。

戻り値

リポジトリ情報コレクション

fetchFirstLevelFileNames

指定ディレクトリだけに関する、フィルタが適用された、即時ファイル/ディレクトリ名および詳細を戻します。取得されるファイルおよびディレクトリ名とその詳細について、リスト オブジェクトに読み込まれ、戻されます。

指定ディレクトリ名がヌルの場合、ファイル名の取得は、リポジトリのルート ディレクトリから行われます。

指定フィルタがヌルの場合、取得されるすべてのファイル名がクライアントに送信されます。

指定フィルタがヌルではない場合、ディレクトリ名およびファイル名がフィルタに対して検証されます。検証に失敗すると、このディレクトリ名およびファイル名はスキップされます。この API は結果を返すまで、数秒間待機します。それ以外の場合は、その時点で取得済みの結果を戻します。この API は、以降の結果のためのバックグラウンド プロセスを作成します。クライアントは、以降の結果に対して getResultsFromConnection(OpContext, String) API を呼び出すことができます。結果の最後は、名前「:End:」を含むファイルで示されます。

パラメータ

opContext：動作コンテキスト

connectionId：取得が行われるリポジトリの ConnectionId

dir：dir は、ファイルおよびディレクトリ名取得が行われるディレクトリです。

filter：フィルタは、リポジトリから取得されるディレクトリおよびファイル名に適用されます。

includeFileNames：リポジトリからファイル名も取得されるか、ディレクトリ名だけが取得されるかを示します。

戻り値

指定 connectionId のリポジトリから取得および読み込まれるリストを戻します。

fetchRecursivelyFileNames

指定ディレクトリから再帰的にファイル名とその詳細を取得します。これにはフィルタが適用されます。取得されるファイルおよびディレクトリ名について、リスト オブジェクトに読み込まれ、戻されます。

指定ディレクトリ詳細がヌルの場合、取得は、リポジトリのルート ディレクトリから行われます。

指定フィルタがヌルの場合、取得されるすべてのファイル詳細がクライアントに送信されます。

指定フィルタがヌルではない場合、ディレクトリおよびファイル名がフィルタに対して検証されます。検証に失敗すると、このディレクトリおよびファイル情報はスキップされます。この API は結果を返すまで、数秒間待機します。それ以外の場合は、その時点で取得済みの結果を戻します。この API は、以降の結果のためのバックグラウンド プロセスを作成します。クライアントは、以降の結果に対して getResultsFromConnection(OpContext, String) API を呼び出すことができます。結果の最後は、名前「:End:」を含むファイルで示されます。

パラメータ

opContext：動作コンテキスト

connectionId：取得が行われるリポジトリの ConnectionId

dir：dir は、ファイルおよびディレクトリ名取得が行われるディレクトリです。

filter：フィルタは、リポジトリから取得されるディレクトリおよびファイル名に適用されます。

includeFileNames：リポジトリからファイル名も取得されるか、ディレクトリ名だけが取得されるかを示します。

戻り値

指定 connectionId のリポジトリから取得および読み込まれるリストを戻します。

fetchResultsFromConnection

この API は、現在実行中のプロセスまたは現在の接続の集約結果を戻します。クライアントは、通常、getFirstLevelFileNames(OpContext, String, String, String, Boolean)、getRecursivelyFileNames(OpContext, String, String, String, Boolean) を呼び出した後にリストの最後に到達してない場合に、この API を呼び出します。この API は、リストの最後に到達するまで、ループから呼び出され、現在のプロセスの結果を取得します。リストの最後は、結果コレクションの名前「:End:」を含むファイルから示されます。これは、結果をプロセスから戻して、同じ結果をプロセスからクリアします。これは、この API を連続して呼び出しても、同じ結果コレクションを再び戻すことはないためです。現在のプロセスは、API abortCurrentProcess(OpContext, String) で中断できます。

パラメータ

opContext：動作コンテキスト

connectionId：取得が行われるリポジトリの ConnectionId

戻り値

指定 connectionId のリポジトリから取得および読み込まれるリストを戻します。

modifyRepositoryServers

DCNM サーバで指定リポジトリ情報コレクションを変更して、同じコレクションを戻します。

パラメータ

opContext：動作コンテキスト

modRepLocationCol：変更されたリポジトリ情報コレクション。

戻り値

変更されたリポジトリ情報コレクションを戻します。

validateConnectivity

この API は、リポジトリが接続可能かどうかを検証するときに使用され、接続障害の原因に適したメッセージを戻します。

パラメータ

opContext：動作コンテキスト

repositoryCol：接続を検証する必要があるリポジトリ コレクション

戻り値

ペア オブジェクト コレクションを戻します。ペア オブジェクトは、ブール アトリビュートおよびメッセージ文字列へのリファレンスを保持します。ブール アトリビュートは、リポジトリが接続可能かどうかを示します。メッセージ文字列は、接続障害の原因に関する情報を含みます。

synchronizeUserCreditenalsMap

サーバからすべてのリポジトリ ユーザ資格情報を取得して、ローカルで保持されるサーバ パスワード マップにロードします。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

パラメータ

opContext：動作コンテキスト

戻り値

リポジトリ情報を戻します。