Cisco Cisco Prime Optical 10.6 Developer's Guide
Cisco Prime Optical 10.6 GateWay/CORBA Programmer Reference Guide
187
3.6.12 unprovisionEquipment
Synopsis
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 and, ONS NCS2000 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, Prime Optical 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, Prime Optical throws the
EXCPT_UNABLE_TO_COMPLY exception.
In case of NCS 2000 SONET and NCS 2000 SDH, when unprovisionEquipment is invoked on slot 18 of
M15 chassis on ECU equipment, Prime optical throws the EXCPT_UNABLE_TO_COMPLY exception.
Parameters
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 and, ONS NCS2000 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, Prime Optical 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, Prime Optical throws the
EXCPT_UNABLE_TO_COMPLY exception.
In case of NCS 2000 SONET and NCS 2000 SDH, when unprovisionEquipment is invoked on slot 18 of
M15 chassis on ECU equipment, Prime optical throws the EXCPT_UNABLE_TO_COMPLY exception.
Parameters
Name
Type
Input/Output
Description
equipmentName
globaldefs::NamingAttributes_T In
Name of the
equipment to
unprovision.
equipment to
unprovision.
This interface is not applicable for configuring payloads for client ports in TXP_MR_10G.
Throws
Compliance
TMF-defined.
TMF-defined.