Table Of Contents

KeyChainApp Service

Information About KeyChainApp Service

createKeyChains

deleteKeyChains

getKeyChains

getKeyChainsById

modifyKeyChains

KeyChainApp Service

---

This chapter describes the DCNM web services' API methods for the KeyChainApp service.

Information About KeyChainApp Service

Keychain management allows you to configure shared secrets on all the entities that exchange secrets (such as keys before establishing trust with each other). Routing protocols and network management applications often use authentication to enhance security while communicating with peers. The API categories are as follows:

•Query/Get APIs—Query data from the persistent database.

•Modify APIs—Modify existing key chain and key chain entries.

•Delete APIs—Delete existing key chains from the device.

createKeyChains

Creates a keyChain in the associated NetworkElement

Following associations are to be provided for the given KeyChain:

•NetworkElement corresponding to the KeyChain AbstractNetworkElement reference

ValidationException is thrown if any of the following situation occurs:

•If keyChainCol is null or empty or it is not of type KeyChain.

Parameters

opContext—Operational context

keyChainCol—List of KeyChain objects

Return Value

List of InstanceNameIds of (@link com.cisco.dcbu.dcm.model.auth.KeyChain}

deleteKeyChains

Deletes one or more KeyChains configured in the device given a list of instanceNameIds of KeyChain.

ValidationException is thrown if any of the following situation occurs:

•If keyChainIdsCol is null or it is not of type InstanceNameId.

•If keyChainIdsCol is not a valid KeyChain InstanceNameId.

Parameters

opContext—Operational context

keyChainIdsList—List of InstanceNameIds of KeyChain

Return Value

void

getKeyChains

Returns the keyChain configured in the specified network Elements.

ValidationException is thrown if any of the following situation occurs:

•If neInstanceNameIdCol is null or it is not of type InstanceNameId.

•If neInstanceNameIdCol is not a valid object tracking InstanceNameId.

Parameters

opContext—Operational context

neInstanceNameIdCol—List of InstanceNameId of one or more network elements.

Return Value

List (@link com.cisco.dcbu.dcm.model.auth.KeyChain} objects.The returned objects contain the following associations, all other associations will be cleared.

•AbstractNetworkElement for KeyChain

•KeyChainEntry association for KeyChain

•KeyChain association for KeyChainEntry

getKeyChainsById

Returns the keyChain corresponding to the instance name id.

ValidationException is thrown if any of the following situation occurs:

•If keyChainInstanceNameIdCol is null or empty or it is not of type InstanceNameId.

•If keyChainInstanceNameIdCol is not a valid InstanceNameId of KeyChain object.

Parameters

opContext—Operational context

keyChainInstanceNameIdCol—List of InstanceNameId if one or more KeyChain.

Return Value

Returns a list of keyChain objects. The returned objects contain the following associations, all other associations will be cleared.

•AbstractNetworkElement for KeyChain

•KeyChainEntry association for KeyChain

•KeyChain association for KeyChainEntry

modifyKeyChains

Modifies one or more existing KeyChain objects.

ValidationException is thrown if any of the following situation occurs:

•If keyChainCol is null or empty or it is not of type KeyChain.

Parameters

opContext—Operational context

keyChainCol—List of modified KeyChain objects

Return Value

List of modified KeyChain Objects persisted in the database.The returned objects contain the following associations, all other associations will be cleared.

•AbstractNetworkElement for KeyChain

•KeyChainEntry association for KeyChain

•KeyChain association for KeyChainEntry