Web Services API Guide, Cisco DCNM for LAN, Release 5.x
PreprovisionApp
Downloads: This chapterpdf (PDF - 82.0KB) The complete bookPDF (PDF - 11.08MB) | Feedback

PreprovisionApp Service

Table Of Contents

PreprovisionApp Service

Information About PreprovisionApp Service

createPreprovisionedSlots

deletePreprovisionedSlots

getPreprovisionedSlots

getPreprovisionedSlotsInNetworkElements

modifyPreprovisionedSlots


PreprovisionApp Service


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

Information About PreprovisionApp Service

This interface defines all the APIs exposed by the PreprovisionApp service facade.

createPreprovisionedSlots

Creates PreprovisionedSlot for the given list and returns the list of PreprovisionedSlot instancename Ids.

ValidationException is thrown if the following situation occurs:

If the neInstanceNameIdCol is null or the collection is empty.

If the neInstanceNameIdCol contain one or more null element, or the collection contains objects that are not valid InstanceNameId of network elements.

If the preProvisionedSlotCol is null or the collection is empty.

If the preProvisionedSlotCol contains one or more null element, or the collection contains objects that are not of type PreprovisionedSlot.

ParameterException is thrown if the following situation occurs:

If PreprovisionedSlot collection size is not equal to the Device Id collection.

PropertiesException is thrown if the following situation occurs:

If the preProvisionedSlotCol collection or any of the PreprovisionedSlot attributes is not valid.

IntegrityException is thrown if the following situation occurs:

If the preProvisionedSlotCol contains a PreprovisionedSlot that is already present in the database.

Parameters

opContext—Operational context.

neInstanceNameIdCol—One or more InstanceNameIds of the network elements.

preProvisionedSlotCol—One or more PreprovisionedSlot objects that must be created.

Return Value

Newly created PreprovisionedSlot objects.

deletePreprovisionedSlots

Deletes one or more PreprovisionedSlot objects.

ValidationException is thrown if any of the following situation occurs:

If preProvisionedSlotInstanceNameIdCol collection is null or it is empty.

If preProvisionedSlotInstanceNameIdCol collection contains an element that is not of type PreprovisionedSlot InstanceNameId.

If preProvisionedSlotInstanceNameIdCol collection contains a PreprovisionedSlot that does not present in the database.

Parameters

opContext—Operational context.

preProvisionedSlotInstanceNameIdCol—A collection that contains InstanceNameId of one or more PreprovisionedSlot objects that must be deleted.

Return Value

void.

getPreprovisionedSlots

Returns a list of PreprovisionedSlot objects corresponding to given collection of InstanceNameIds.

ValidationException is thrown any of the following situation occurs:

If preProvisionedSlotInstanceNameIdCol is null or empty.

If preProvisionedSlotInstanceNameIdCol contains invalid InstanceNameId of a PreprovisionedSlot.

If preProvisionedSlotInstanceNameIdCol contains a null value.

If there is no equivalent PreprovisionedSlot object with the given InstanceNameId in the preProvisionedSlotInstanceNameIdCol.

Parameters

opContext—Operational context.

preProvisionedSlotInstanceNameIdCol—A collection of InstanceNameId of PreprovisionedSlot.

Return Value

A list of PreprovisionedSlot objects.

getPreprovisionedSlotsInNetworkElements

Returns all the PreprovisionedSlot objects configured in the list of network elements.

InstanceException is thrown any of the following situation occurs:

If the argument passed neInstanceNameIdCol is null or is empty.

If the element in the collection is not a valid network element InstanceNameId.

Parameters

opContext—Operational context.

neInstanceNameIdCol—A collection of one or more InstanceNameId of network elements.

Return Value

A list of PreprovisionedSlot objects.

modifyPreprovisionedSlots

Modifies one or more existing PreprovisionedSlot objects.

ValidationException is thrown if any of the following situation occurs:

If preProvisionedSlotCol collection is null or it is empty.

If preProvisionedSlotCol collection contains an object that is not of type PreprovisionedSlot.

IntegrityException is thrown if any of the following situation occurs:

If the preProvisionedSlotCol collection contains a PreprovisionedSlot that does not exist in the database.

You must call a separate API to bind the PreprovisionedSlot to an interface.

Parameters

opContext—Operational context.

preProvisionedSlotCol—A collection of PreprovisionedSlot objects that will replace the existing PreprovisionedSlot objects in the database.

Return Value

The modified PreprovisionedSlot objects.