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

目次

KeyChainApp サービス

KeyChainApp サービスについて

createKeyChains

deleteKeyChains

getKeyChains

getKeyChainsById

modifyKeyChains

KeyChainApp サービス

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

KeyChainApp サービスについて

キー チェーン管理では、秘密キー(お互いの信頼状態を確立する前のキーなど)を交換するすべてのエンティティで共有秘密キーを設定できます。ルーティング プロトコルおよびネットワーク管理アプリケーションは、通常、認証を使用して、ピア間通信中のセキュリティを改善します。API カテゴリは次のとおりです。

Query/Get API:永続的なデータベースのデータを照会します。

Modify API:既存のキー チェーンおよびキー チェーン エントリを変更します。

Delete API:既存のキー チェーンをデバイスから削除します。

createKeyChains

関連する NetworkElement で keyChain を作成します。

次のアソシエーションが、指定の KeyChain に提供されます。

KeyChain AbstractNetworkElement リファレンスに対応する NetworkElement

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

keyChainCol がヌルまたは空の場合、またはタイプ KeyChain ではない場合。

パラメータ

opContext:動作コンテキスト

keyChainCol:KeyChain オブジェクトのリスト

戻り値

(@link com.cisco.dcbu.dcm.model.auth.KeyChain) の InstanceNameId のリスト

deleteKeyChains

KeyChain の instanceNameId のリストで指定されたデバイスに設定されている 1 つまたは複数の KeyChain を削除します。

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

keyChainIdsCol がヌルの場合、またはタイプ InstanceNameId ではない場合。

keyChainIdsCol が有効な KeyChain InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

keyChainIdsList:KeyChain の InstanceNameId のリスト

戻り値

void

getKeyChains

指定ネットワーク要素に設定されている keyChain を戻します。

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

neInstanceNameIdCol がヌルの場合、またはタイプ InstanceNameId ではない場合。

neInstanceNameIdCol が有効なオブジェクト トラッキング InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:1 つまたは複数のネットワーク要素の InstanceNameId のリスト。

戻り値

(@link com.cisco.dcbu.dcm.model.auth.KeyChain) オブジェクトをリストします。戻されるオブジェクトには、次のアソシエーションが含まれます。その他のすべてのアソシエーションはクリアされます。

KeyChain の AbstractNetworkElement

KeyChain の KeyChainEntry アソシエーション

KeyChainEntry の KeyChain アソシエーション

getKeyChainsById

インスタンス名 ID に対応する keyChain を戻します。

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

keyChainInstanceNameIdCol がヌルまたは空の場合、またはタイプ InstanceNameId ではない場合。

keyChainInstanceNameIdCol が有効な KeyChain オブジェクトの InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

keyChainInstanceNameIdCol:1 つまたは複数の KeyChain の場合、InstanceNameId のリスト。

戻り値

keyChain オブジェクトのリストを戻します。戻されるオブジェクトには、次のアソシエーションが含まれます。その他のすべてのアソシエーションはクリアされます。

KeyChain の AbstractNetworkElement

KeyChain の KeyChainEntry アソシエーション

KeyChainEntry の KeyChain アソシエーション

modifyKeyChains

1 つまたは複数の既存の KeyChain オブジェクトを変更します。

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

keyChainCol がヌルまたは空の場合、またはタイプ KeyChain ではない場合。

パラメータ

opContext:動作コンテキスト

keyChainCol:変更された KeyChain オブジェクトのリスト

戻り値

データベースで保持されている変更された KeyChain オブジェクトのリスト。戻されるオブジェクトには、次のアソシエーションが含まれます。その他のすべてのアソシエーションはクリアされます。

KeyChain の AbstractNetworkElement

KeyChain の KeyChainEntry アソシエーション

KeyChainEntry の KeyChain アソシエーション