Cisco Cisco Prime Optical 10.6 Developer's Guide
Cisco Prime Optical 10.6 GateWay/CORBA Programmer Reference Guide
184
Throws
Compliance
TMF-defined.
TMF-defined.
3.6.9 provisionEquipment
Synopsis
Description
This interface enables the NMS to permanently provision a piece of equipment in an equipment holder in
an ME. The result of this operation is the creation of the equipment object and all of its related objects,
such as TPs. The resulting object is returned.
The equipment holder that contains the equipment must exist. The equipment object can already exist, but
the equipment holder must not have expected equipment already provisioned.
If the equipment is provisioned successfully, Prime Optical generates a state change event on the holder
state change and an object creation event for the equipment, and pushes them to the event channel.
It is important to note that the ONS 15454 SONET and ONS NCS2K SONET detects new equipment and
provisions it automatically, provided that the equipment holder (slot) is empty and is not preprovisioned
for another module type.
The equipment must be from the acceptableEquipmentTypeList of the slots. If these slots are selected to
provision any other type of card, Prime Optical returns the EXCPT_UNABLE_TO_COMPLY exception.
PPMs and PIMs can also be provisioned using this interface.
It is not necessary to know the subtypes of the OC-n card at the time of provisioning. When equipment is
actually installed, Prime Optical reports the subtype in the name field of the equipment.
For the ONS 15600 SONET and ONS 15600 SDH, each CXC or SSXC card occupies two slots (slots 6
and 7 or slots 8 and 9), and the NMS can specify any one of the slots to provision a CXC or SSXC card.
Parameters
This interface enables the NMS to permanently provision a piece of equipment in an equipment holder in
an ME. The result of this operation is the creation of the equipment object and all of its related objects,
such as TPs. The resulting object is returned.
The equipment holder that contains the equipment must exist. The equipment object can already exist, but
the equipment holder must not have expected equipment already provisioned.
If the equipment is provisioned successfully, Prime Optical generates a state change event on the holder
state change and an object creation event for the equipment, and pushes them to the event channel.
It is important to note that the ONS 15454 SONET and ONS NCS2K SONET detects new equipment and
provisions it automatically, provided that the equipment holder (slot) is empty and is not preprovisioned
for another module type.
The equipment must be from the acceptableEquipmentTypeList of the slots. If these slots are selected to
provision any other type of card, Prime Optical returns the EXCPT_UNABLE_TO_COMPLY exception.
PPMs and PIMs can also be provisioned using this interface.
It is not necessary to know the subtypes of the OC-n card at the time of provisioning. When equipment is
actually installed, Prime Optical reports the subtype in the name field of the equipment.
For the ONS 15600 SONET and ONS 15600 SDH, each CXC or SSXC card occupies two slots (slots 6
and 7 or slots 8 and 9), and the NMS can specify any one of the slots to provision a CXC or SSXC card.
Parameters
Name
Type
Input/
Output Description
Output Description
equipmentCreateData EQTCreateData_T In
Data that describes the equipment to create.
createdEquipment
Equipment_T
Out
Resulting created equipment.
Prime Optical support for EQTCreateData_T structure is as follows:
• string userLabel
– Not supported.
• boolean forceUniqueness
– Not supported.
• string owner
– Not supported.