User guide

3-78
Cisco Transport Manager Release 9.2 GateWay/CORBA User Guide and Programmer Manual
OL-20937-01
Chapter 3 Using CTM GateWay/CORBA Interfaces
3.6.12 unprovisionEquipment
3.6.12 unprovisionEquipment
Synopsis
void unprovisionEquipment(
in globaldefs::NamingAttributes_T equipmentName)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables the NMS to permanently unprovision equipment from the managed element. The
successful result of this operation is the potential deletion of the equipment object and all of its related
objects, such as termination points.
The ONS 15454 SONET does not allow a user to unprovision a piece of equipment that is in use (SNC
is created on this equipment). However, if the equipment is present in the slot and is not in use, it can be
unprovisioned. If the equipment is not physically removed from the slot and new equipment is not
provisioned in the same slot, the NE redetects the equipment in approximately 1 minute. If the
equipment is not physically removed from the slot and new equipment of a different type is provisioned
in the same slot, the NE generates an equipment mismatch alarm.
If the equipment is unprovisioned successfully, CTM generates a state change event on the holder state
change and an object deletion event for the equipment, and pushes them to the event channel.
The ONS 15454 reserves slots 7 and 11 for TCC. One of these slots has an in-service TCC card. If the
NMS invokes unprovisionEquipment on this equipment, CTM throws the
EXCPT_UNABLE_TO_COMPLY exception.
Parameters
Note This interface is not applicable for configuring payloads for client ports in TXP_MR_10G.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object.
EXCPT_OBJECT_IN_USE - Deletion is rejected because equipment resources are in use.
EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references an object that does not
exist.
EXCPT_UNABLE_TO_COMPLY - Raised when the equipment cannot be unprovisioned at the NE.
EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.
Compliance
TMF-defined.
Name Type Input/Output Description
equipmentName globaldefs::NamingAttributes_T In Name of the equipment to unprovision.