Cisco DCNM Web Services API ガイド Release 4.0
KeyChainApp Service
KeyChainApp Service
発行日;2012/01/11 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

KeyChainApp Service

KeyChainApp サービスの概要

createKeyChains

deleteKeyChains

getKeyChains

getKeyChainsById

modifyKeyChains

KeyChainApp Service

この章では、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} の InstanceNameIds のリスト

deleteKeyChains

KeyChain の instanceNameIds リストの場合、デバイスに設定された 1 つまたは複数の KeyChains を削除します。

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

keyChainIdsList ― KeyChain の InstanceNameIds のリスト

戻り値

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 アソシエーション