This chapter describes each interface that CTM supports, including TeleManagement Forum (TMF)-specific and Cisco-proprietary interfaces. This chapter includes the following information:
Note The iterator interfaces defined by the TMF are not listed here. CTM implementation of these interfaces does not deviate from the TMF definition.
3.1 Overview of APIs Supported by NE Type
The following table lists each API and the NEs that support it.
Table 3-1 APIs Supported by NE Type
API No.
GateWay/CORBA API
Supported NEs
1
common::Common_I::getCapabilities
—
2
emsMgr::EMSMgr_I::getAllEMSAndMEActiveAlarms
CRS-1, ONS 15302, ONS 15305, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 1580x, XR 12000
3
emsMgr::EMSMgr_I::getAllEMSSystemActiveAlarms
—
4
emsMgr::EMSMgr_I::getAllTopLevelSubnetworks
—
5
emsMgr::EMSMgr_I::getAllTopLevelSubnetworkNames
—
6
emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks
ONS 15302, ONS 15305, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 1580x
ONS 15302, ONS 15305, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 1580x
8
emsMgr::EMSMgr_I::getTopLevelTopologicalLink
ONS 15302, ONS 15305, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 1580x
9
emsMgr::EMSMgr_I::createTopologicalLink
CRS-1, MDS 9000, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 1580x, unmanaged NE
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET
11
emsMgr::EMSMgr_I::deleteTopologicalLink
CRS-1, MDS 9000, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 1580x, unmanaged NE
12
emsMgr::EMSMgr_I::modifyTopologicalLink
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET
13
emsMgr::EMSMgr_I::getEMS
—
14
emsMgr::EMSMgr_I::getAllL2Topologies
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
15
emsMgr::EMSMgr_I::getAllQoSTemplateNames
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
16
emsMgr::EMSMgr_I::getAllQoSTemplates
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
17
emsMgr::EMSMgr_I::getQoSTemplate
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
18
emsMgr::EMSMgr_I::getAllEMSandMEClearedAlarms
ONS 15305, ONS 15302, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 1580x
19
emsMgr::EMSMgr_I::getAllEMSSystemClearedAlarms
All
20
emsMgr::EMSMgr_I::createServerTrailLink
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
21
emsMgr::EMSMgr_I::deleteServerTrailLink
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
CRS-1, MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808, XR 12000
CRS-1, MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808, XR 12000
CRS-1, MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808, XR 12000
CRS-1, MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808, XR 12000
CRS-1, MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SONET, ONS 15600 SDH, ONS 15800, ONS 15801, ONS 15808, XR 12000
CRS-1, MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808, XR 12000
CRS-1, MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808, XR 12000
40
equipment::EquipmentInventoryMgr_I::getEquipment
CRS-1, MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808, XR 12000
CRS-1, MDS 9000, MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808, XR 12000
CRS-1, MDS 9000, MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808, XR 12000
CRS-1, ONS 15216, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 1580x, XR 12000
CRS-1, ONS 15216, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 1580x
CRS-1, ONS 15216, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 1580x
CRS-1, ONS 15216, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 1580x
This service retrieves the capabilities of the manager. All nonspecified capabilities are assumed to be unsupported.
Parameters
Name
Type
Input/Output
Description
capabilities
CapabilityList_T
Out
List of capabilities of this manager object. It is a name-value pair, where the name represents the feature or capability and the value represents the support or nonsupport of the specified feature or capability.
A Capability_T value is used to identify a functionality supported by the EMS across the NML-EML interface. It is a name/value pair, in which the name represents the feature/capability name and the value represents the support or nonsupport of the specified feature/capability.
The EMS capabilities for this release include individual IDL operation support. The feature/capability name part is used to identify an IDL operation using the following convention:
module_name::interface_name::operation_name
The currently defined values are as follows:
•Supported—The specified feature/capability is fully or partially supported across the network management layer-element management layer (NML-EML) interface; an operation may be partially supported if not all values of the parameters are supported.
•Unsupported—The specified feature/capability is not supported at all across the NML-EML interface.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
Compliance
TMF-defined.
3.3 emsMgr::EMSMgr_I
The EMSMgr_I interface accesses operations that deal with the Element Management System (EMS) itself. A handle to an instance of this interface is gained through the emsSession::EmsSession_I::getManager operation in emsSession. This interface is inherited from common::Common_I.
interface EMSMgr_I:common::Common_I
This interface implements the getCapabilities method. Operations described in the following sections are returned to the network management system (NMS) when it invokes getCapabilities.
in notifications::ProbableCauseList_T excludeProbCauseList,
in notifications::PerceivedSeverityList_T excludeSeverityList,
in unsigned long how_many,
out notifications::EventList_T eventList,
out notifications::EventIterator_I eventIt)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to request active alarms that are under the control of the EMS (alarms raised by the NEs and alarms raised by the EMS itself). Some alarms might be filtered out (excluded) by specifying their probable causes or severities.
Due to performance concerns, only one OSS client is allowed to invoke this operation at a time. Otherwise, CTM throws an EXCPT_UNABLE_TO_COMPLY exception.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
ONS 15310, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SONET, and ONS 15600 SDH
ONS 15310, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SONET, and ONS 15600 SDH do not send a "clear" for the TCA events. The TCAs are not reported in the eventList returned by this method.
ONS 15540, ONS 15530, and ONS 15501
TCAs are also reported in the eventList returned by this method as ONS 15540 sends a "clear" for the threshold crossing alarms.
Parameters
Name
Type
Input/Output
Description
excludeProbCauseList
notifications::ProbableCauseList_T
In
The list of probable causes to exclude (for which events should not be reported).
excludeSeverityList
notifications::PerceivedSeverityList_T
In
List of severities to exclude from the output event list.
how_many
unsigned long
In
Maximum number of alarms to report in the first batch.
eventList
notifications::EventList_T
Out
First batch of alarms.
eventIt
notifications::EventIterator_I
Out
Iterator to retrieve the remaining alarms.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_UNABLE_TO_COMPLY - Raised when this method is being used by another OSS client.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators has reached
128.
in notifications::PerceivedSeverityList_T excludeSeverityList,
in unsigned long how_many,
out notifications::EventList_T eventList,
out notifications::EventIterator_I eventIt)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to request all active alarms for the EMS. Some alarms can be filtered out (excluded) by specifying their severities.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
Parameters
Name
Type
Input/Output
Description
excludeSeverityList
notifications::PerceivedSeverityList_T
In
List of severities to exclude from the output event list.
how_many
unsigned long
In
Maximum number of alarms to report in the first batch.
eventList
notifications::EventList_T
Out
First batch of alarms.
eventIt
notifications::EventIterator_I
Out
Iterator to retrieve the remaining alarms.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators has reached
128.
Compliance
TMF-defined.
3.3.3 emsMgr::EMSMgr_I::getAllTopLevelSubnetworks
Synopsis
void getAllTopLevelSubnetworks(
in unsigned long how_many,
out multiLayerSubnetwork::SubnetworkList_T sList,
out multiLayerSubnetwork::SubnetworkIterator_I sIt)
raises(globaldefs::ProcessingFailureException);
Description
This method enables an NMS to request all subnetworks that are under the control of the EMS.
Parameters
Name
Type
Input/Output
Description
how_many
unsigned long
In
Maximum number of subnetworks to return in the first batch.
sList
multiLayerSubnetwork::SubnetworkList_T
Out
First batch of subnetworks.
sIt
multiLayerSubnetwork::SubnetworkIterator_I
Out
Iterator to retrieve the remaining subnetworks.
CTM support for MultiLayerSubnetwork_T is as follows:
•globaldefs::NamingAttributes_T name
–Supported. This field contains two tuples. The first tuple identifies the EMS. The second tuple is the same as nativeEMSName. The naming convention is described in 2.2.5.1 Multilayer Subnetwork, page 2-40.
•string userLabel
–Supported.
•string nativeEMSName
–Supported.
•string owner
–Not supported.
•Topology_T subnetworkType
–Supports TOPO_SINGLETON, TOPO_CHAIN, TOPO_PSR, TOPO_OPEN_PSR, TOPO_SPRING, TOPO_OPEN_SPRING, and TOPO_MESH.
out globaldefs::NamingAttributesIterator_I nameIt)
raises(globaldefs::ProcessingFailureException);
Description
This operation has exactly the same behavior as the operation described in emsMgr::EMSMgr_I::getAllTopLevelSubnetworks, but instead of returning entire object structures, this operation returns their names.
Parameters
Name
Type
Input/Output
Description
how_many
unsigned long
In
Maximum number of subnetworks to return in the first batch.
sList
globaldefs::NamingAttributesList_T
Out
First batch of subnetwork names.
sIt
globaldefs::NamingAttributesIterator_I
Out
Iterator to retrieve the remaining subnetwork names.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators has reached
128.
out topologicalLink::TopologicalLinkList_T topoList,
out topologicalLink::TopologicalLinkIterator_I topoIt)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to request all of the top-level topological links that are under the control of the EMS. A top-level topological link is a topological link in which the endpoints of the topological link exist in two different multilayer subnetworks.
If the link is under the control of the EMS and then removed from the NE, the ProvType parameter is reported as INVALID.
Parameters
Name
Type
Input/Output
Description
how_many
unsigned long
In
Maximum number of top-level topological links to return in the first batch.
topoList
topologicalLink::TopologicalLinkList_T
Out
First batch of top-level topological links.
topoIt
topologicalLink::TopologicalLinkIterator_I
Out
Iterator to retrieve the remaining top-level topological links.
CTM support for TopologicalLink_T structure is as follows:
•globaldefs::NamingAttributes_T name
–Supported. This field has two tuples. The first tuple is for the EMS. The second is for the topological link. The value in the second tuple is the same as the nativeEMSName field except for the Y-cable links, which will have "::1" and "::2" appended to the nativeEMSName to identify the two legs of the Y-cable link.
out globaldefs::NamingAttributesIterator_I nameIt)
raises(globaldefs::ProcessingFailureException);
Description
This operation has exactly the same behavior as the operation described in emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks, but instead of returning entire object structures, this operation returns their names.
Parameters
Name
Type
Input/Output
Description
how_many
unsigned long
In
Maximum number of top-level topological links to return in the first batch.
nameList
globaldefs::NamingAttributesList_T
Out
First batch of top-level topological link names.
nameIt
globaldefs::NamingAttributesIterator_I
Out
Iterator to retrieve the remaining top-level topological link names.
Throws
globaldefs::ProcessingFailureException
EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators has reached
128.
This operation enables an NMS to request the top-level topological link given that its name is under the control of the EMS.
If the link is under the control of the EMS and then removed from the NE, the ProvType parameter is reported as INVALID.
Parameters
Name
Type
Input/Output
Description
topoLinkName
globaldefs::NamingAttributes_T
In
Name of the topological link.
topoLink
TopologicalLink::TopologicalLink_T
Out
Top-level topological link.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when topoLinkName does not reference a top level topological
link object.
EXCPT_ENTITY_NOT_FOUND - Raised when topoLinkName references a top level topological link
object that does not exist in the EMS.
Compliance
TMF-defined.
3.3.8 emsMgr::EMSMgr_I::createTopologicalLink
Synopsis
void createTopologicalLink(
in topologicalLink::TLCreateData_T createData,
out topologicalLink::TopologicalLink_T topologicalLink)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to create a topological link manually between two MEs. CTM supports topological link creation between MEs belonging to the same multilayer subnetwork. If CTM autodiscovers a topological link between two endpoints on which a manually created link exists, CTM overwrites the manually created topological link information with the autodiscovered topological link information. CTM generates an attribute value change event when a manually created link is overwritten with autodiscovered topological link information. CTM supports topological link creation between two unmanaged NEs, and also between a managed NE and an unmanaged NE. CTM ignores the topological link layer rate if the topological link creation is between two unmanaged NEs.
CTM generates an object creation event notification when a new topological link is created.
Note•TLCreateData_T is a CTM-defined data structure. The TMF proposed this structure and included it in the TMF 3.0 specification.
•CTM creates topological links between two PTPs even if there are no existing physical link connections in the network. To actually enable traffic through the link, the NMS must ensure physical link connectivity and enable SDCC on the topological link.
•For links that involve a CRS-1 PTP on one end, only the following layer rates are supported: LR_Physical_10_Gigabit_ITU = 107 and LR_Physical_40_Gigabit_ITU = 152.
Parameters
Name
Type
Input/Output
Description
createData
topologicalLink::TLCreateData_T
In
Data structure containing details for creating new topological links.
topologicalLink
topologicalLink::TopologicalLink_T
Out
Created topological link information.
CTM support for TLCreateData_T structure is as follows:
•string userLabel
–Supported. The value of this field is assigned to the name of the newly created topological link. For patchcord links, CTM assigns the link name. The user label that is passed as input is ignored for patchcord links.
•boolean forceUniqueness
–CTM guarantees the uniqueness of topological link names.
–Supported. The supported parameters are listed in the following table:
Managed Element Type
Parameter Name
Supported Parameter Values
All ManagedElements that support topological links
linkProtectionType
PROT_ONE_PLUS_ONE.
All ManagedElements that support topological links
linkCost
int, 1 to 2147483647.
All ManagedElements that support topological links
provType
MANUAL (default value) and PATCHCORD.
•globaldefs::sSrlgGroupList_T srlgGroupListValue
–Supported. This field holds the shared risk link group (SRLG) group values. This is an optional parameter. The user can include the SRLG group during link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH topological links.
Throws
globaldefs::ProcessingFailureException
EXCPT_NOT_IMPLEMENTED - Raised if input createData is not valid.
EXCPT_INVALID_INPUT - Raised if the EMS cannot support this service.
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
Compliance
CTM-defined. This interface is already proposed in TMF and will be included in TMF Release 3.0.
out topologicalLink::TopologicalLink_T topologicalLink)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to create a Y-cable topological link manually between two ManagedElements. A Y-cable link is a bidirectional link with one PTP source and two PTP destinations. Because of the limitation in TMF for TopologicalLinks having one PTP source and one PTP destination, CTM will report two TopologicalLinks for a Y-cable link. These two topological links will have the same nativeEMSName. See 2.2.5.8 Topological Link, page 2-47 for the naming convention for the Y-cable TopologicalLink object name. The destination of the Y-cable link must be on a DWDM card on an ONS 15454 SONET/SDH or on an ONS 155xx NE.
CTM generates two object creation event notifications when a new Y-cable topological link is created.
The TopologicalLink returned from this method is one leg of the Y-cable.
Parameters
Name
Type
Input/Output
Description
createData
topologicalLink:MTLCreateData_T
In
Data structure containing details for creating a new Y-cable topological link.
topologicalLink
topologicalLink::TopologicalLink_T
Out
One leg of the created Y-cable topological link information.
CTM support for MTLCreateData_T structure is as follows:
•string userLabel
–Supported. The value of this field will be assigned to the nativeEMSName of the newly created topological link.
•boolean forceUniqueness
–CTM guarantees uniqueness of topological link names.
–Supported. It should contain two PTPs on the same ME.
•globaldefs::NVSList_T additionalInfo
–Supported. The supported parameters are listed in the table below.
Managed Element Type
Parameter Name
Supported Parameter Values
All ManagedElements that support topological links
linkCost
Int, 1 to 2147483647.
All ManagedElements that support topological links
provType
MANUAL (default value) and PATCHCORD.
•globaldefs::sSrlgGroupList_T srlgGroupListValue
–Supported. This field holds the SRLG group values. This is an optional parameter. The user can include the SRLG group during link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH topological links.
Throws
globaldefs::ProcessingFailureException
EXCPT_NOT_IMPLEMENTED - Raised if input createData is not valid.
EXCPT_INVALID_INPUT - Raised if the EMS cannot support this service.
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
Compliance
CTM-defined.
3.3.10 emsMgr::EMSMgr_I::deleteTopologicalLink
Synopsis
void deleteTopologicalLink(
in globaldefs::NamingAttributes_T topoLinkName)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to delete a topological link manually between two ManagedElements. CTM throws the EXCPT_UNABLE_TO_COMPLY exception if an attempt was made to delete an autodiscovered topological link or if the topological link could not be deleted in the current state. CTM generates an object deletion event notification when a topological link is deleted.
Note CTM deletes topological links between two PTPs even if there is a physical link connection in the network. NMS must ensure the disabling of SDCC, deletion of all circuits carried through the link, and removal of the physical link connectivity.
Parameters
Name
Type
Input/Output
Description
topoLinkName
globaldefs::NamingAttributes_T
In
Name of the topological link to delete.
Throws
globaldefs::ProcessingFailureException
EXCPT_INVALID_INPUT - Raised if input topological link name is invalid.
EXCPT_ENTITY_NOT_FOUND - Raised if the specified topological link name does not exist in
CTM.
EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_UNABLE_TO_COMPLY - Raised if attempt is made to delete an auto-discovered
topological link
Compliance
CTM-defined. This interface is already proposed in TMF and will be included TMF Release 3.0.
3.3.11 emsMgr::EMSMgr_I::modifyTopologicalLink
Synopsis
void modifyTopologicalLink(
in topologicalLink::TLCreateData_T newTLCreateData,
out topologicalLink::TopologicalLink_T newTopologicalLink )
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to modify some of the parameters of the existing topological links. The following parameters can be modified using the modifyTopologicalLink API:
•Cost attribute (modifiable only for SONET and SDH links)
•SRLG values (modifiable only for SONET and SDH links)
Note The modifyTopologicalLink method is not supported for links with patchcord provisioning.
Parameters
Name
Type
Input/Output
Description
createData
topologicalLink::TLCreateData_T
In
Data structure containing details for creating a new topological link.
topologicalLink
topologicalLink::TopologicalLink_T
Out
Created topological link information.
CTM support for TLCreateData_T structure is as follows:
•string userLabel
–Supported. The value of this field will be assigned to the name of the newly created topological link.
•boolean forceUniqueness
–CTM guarantees uniqueness of topological link names.
•string owner
–Not supported.
•globaldefs::ConnectionDirection_T direction
–CTM supports CD_BI for bidirectional links and CD_UNI for unidirectional links.
–Supported. The supported parameters are listed in the following table.
Managed Element Type
Parameter Name
Supported Parameter Values
All ManagedElements that support topological links
linkProtectionType
PROT_ONE_PLUS_ONE.
All ManagedElements that support topological links
linkCost
int, 1 - 2147483647.
•globaldefs::sSrlgGroupList_T srlgGroupListValue
–Supported. This field holds the SRLG group values. This is an optional parameter. You can include the SRLG group during link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are supported only for SONET/SDH topological links.
Throws
globaldefs::ProcessingFailureException
EXCPT_INVALID_INPUT - Raised if input createData is not valid.
EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
Compliance
CTM-defined.
3.3.12 emsMgr::EMSMgr_I::getEMS
Synopsis
void getEMS(out EMS_T emsInfo)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to request the EMS information.
Parameters
Name
Type
Input/Output
Description
emsInfo
EMS_T
Out
EMS information.
CTM supports EMS_T is as follows:
•globaldefs::NamingAttributes_T name
–EMS ID is returned as the same name that is displayed on the CTM client EMS property sheet.
•string userLabel
–Not supported.
•string nativeEMSName
–CTM returns the EMS ID that is displayed on the CTM client EMS property sheet.
•string owner
–Not supported.
•string emsVersion
–CTM returns "8.0."
•string type
–CTM returns "Cisco Systems/Cisco Transport Manager."
•globaldefs::NVSList_T additionalInfo
–Not supported.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
out multiLayerSubnetwork::L2TopologyList_T l2TopoList,
out multiLayerSubnetwork::L2TopologyIterator_I l2TopoIt)
raises(globaldefs::ProcessingFailureException);
Description
This interface lists all L2 topologies of a particular topology type in the EMS. The L2 topology has a scope in EMS. CTM supports only Resilient Packet Ring (RPR) and point-to-point L2 topology types.
Parameters
Name
Type
Input/Output
Description
l2TopoType
MultiLayerSubnetwork::L2TopoType_T
In
Type of L2 topologies to return.
how_many
unsigned long
In
Maximum number of L2 topologies to return in the first batch.
l2TopoList
multiLayerSubnetwork::L2TopologyList_T
Out
List of available L2 topologies in this multilayer subnetwork.
l2TopoIt
multiLayerSubnetwork::L2TopologyIterator_I
Out
Iterator used to retrieve the remaining L2 topologies.
CTM support for L2Topology_T structure is as follows:
•globaldefs::NamingAttributes_T name
–Supported. The field contains two tuples. The first tuple contains a value for EMS. The second tuple contains the L2 topology name.
•string userLabel
–Not supported.
•string nativeEMSName
–Supported. L2 topology name will be reported.
•string owner
–Not supported.
•L2TopoLayerRate_T layerRate
–Supported. This represents the total capacity of the L2 topology. L2TopoLayerRate_T contains the following information:
•LayerRate_T layerRate—Represents the layer rate of the SNCs. For VCAT, represents the layer rate of the member SNCs.
•Unsigned long numberOfVcatMembers—Represents the number of members in each SNC of an L2 topology consisting of all VCAT SNCs. It contains a value less than one in all other cases and should be ignored in such cases.
•Supported layer rates are:
LR_STS1_and_AU3_High_Order_VC3
LR_STS3c_and_AU4_VC4
LR_STS6c_and_VC4_2c
LR_STS9c_and_VC4_3c
LR_STS12c_and_VC4_4c
LR_STS24c_and_VC4_8c
LR_Not_Applicable (if the L2 topology contains L1 SNCs with different layer rates or if the L2 topology contains a mix of CCAT and VCAT L1 SNCs)
•multiLayerSubnetwork::L2TopoType l2TopoType
–The type of the L2 topology. Valid values are L2TopoType.PT2PT, L2TopoType.RPR, and L2TopoType.DOT17_RPR.
•multiLayerSubnetwork::L2TopoState topoState
–The state of the L2 topology. Valid values are L2TopoState.COMPLETE and L2TopoState.INCOMPLETE.
•multiLayerSubnetwork::L2TopoOperState
–The operational state of the L2 topology. Valid values are L2TopoOperState.IS, L2TopoOperState.ISPARTIAL, and L2TopoOperState.OOS.
–Indicates the current L2 topology synchronization state. The valid values for L2TopoSyncState are:
•L2TopoSyncState. NEEDED
•L2TopoSyncState. INPROGRESS
•L2TopoSyncState. COMPLETE
•L2TopoSyncState. PARTIALLY_COMPLETE
•L2TopoSyncState. FAILED
•L2TopoSyncState. L2SERVICENOTREADY
•globaldefs::NVSList_T additionalInfo
–Supported.
–If the topology type is DOT17_RPR, the bandwidth parameter values return the absolute bandwidth reserved for the class of traffic. The return value is similar to 250 (Class A). The number 250 indicates 250 Mbps bandwidth reserved for Class A-type traffic. Multicast bandwidth parameters are not supported for this type of topology. If no values are defined for class types, the following default values are returned:
•ClassSpMgmt: C
•ClassCommitted: C
•ClassBestEffort: C
•ClassAvvidControl: B
•ClassAvvidVoiceVideo: A
•ClassAReservedBandwidth: 0
•ClassA1Bandwidth: 10
•ClassBCommittedBandwidth: 10
•SpMgmtCoS: 6, 7
•CommittedCoS: 1, 2
•AvvidVoiceVideoCoS: 5
• AvvidControlCoS: 3
•CosCommit: 2
–The bandwidth parameters SpMgmtBandwidth, CommittedBandwidth, BestEffortBandwidth, AvvidControlBandwidth, SpMgmtCoS, CommittedCoS, AvvidVoiceVideoCoS, AvvidControlCoS, and the CoS value CosCommit are supported. Either all or none of these parameters should be passed. Each of the bandwidth parameters (SpMgmtBandwidth, CommittedBandwidth, BestEffortBandwidth, and AvvidControlBandwidth) should be from 1 to 96; the sum of all four bandwidth parameters should be from 1 to 99. The CoS commit value should be from 0 to 7. If none of these parameters is passed, CTM takes the following default values:
•SpMgmtBandwidth: 5
•CommittedBandwidth: 80
•BestEffortBandwidth: 10
•AvvidControlBandwidth: 4
•SpMgmtCoS: 6, 7
•CommittedCoS: 1, 2
•AvvidVoiceVideoCoS: 5
•AvvidControlCoS: 3
•CosCommit: 2
Throws
globaldefs::ProcessingFailureException
EXCPT_INVALID_INPUT - Raised when an l2TopoType is invalid.
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators that the EMS
can support has been reached.
Compliance
CTM-defined.
3.3.14 emsMgr::EMSMgr_I::getAllQoSTemplateNames
Synopsis
void getAllQoSTemplateNames( in unsigned long how_many,
out globaldefs::NamingAttributesList_T qosTempNameList,
out globaldefs::NamingAttributesIterator_I qosTempNameIt)
raises(globaldefs::ProcessingFailureException);
Description
This interface lists all QoS template names in the EMS. The QoSTemplate has a scope in EMS.
Parameters
Name
Type
Input/Output
Description
how_many
unsigned long
In
Maximum number of qosTempNames to return in the first batch.
qosTempNameList
globaldefs::NamingAttributesList_T
Out
First batch of names.
qosTempNameIt
globaldefs::NamingAttributesIterator_I
Out
Iterator used to retrieve the remaining names.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators that the EMS
can support has been reached.
Compliance
CTM-defined.
3.3.15 emsMgr::EMSMgr_I::getAllQoSTemplates
Synopsis
void getAllQoSTemplates
in unsigned long how_many,
out QoSTemplateList_T qosTempList
out QoSTemplateIterator_I qosTempIt)
raises(globaldefs::ProcessingFailureException);
Description
This interface lists all QoS templates in the EMS. The QoSTemplate has a scope in the EMS.
Parameters
Name
Type
Input/Output
Description
how_many
unsigned long
In
Maximum number of qosTempNames to return in the first batch.
qosTempList
QoSTemplateList_T
Out
First batch of QoS templates.
qosTempIt
QoSTemplateIterator_I
Out
Iterator used to retrieve the remaining QoS templates.
CTM support for QoSTemplate structure is as follows:
•globaldefs::NamingAttributes_T templateName—Supported. This field specifies the template name.
•string qos_template_description—Supported. This field specifies the description of the template.
•emsMgr::TemplateType_T—TemplateType specifies the type of template. CTM supports the following types:
–TemplateType_T.BEST_EFFORT
–TemplateType_T.CIR_PIR
–TemplateType_T.ADVANCED
•QOSPolicy_T policy—Supported. This field specifies the QoS policy for the template.
•QOSPolicy_T is defined as follows:
–string policy_name—Supported. This field specifies the policy name for the QoS.
–QoSClassList_T qosClass—Supported. This provides a list of QoS classes for the policy.
Each QoSClass_T has the following members:
•multiLayerSubnetwork::MatchProtocolList_T classification—Supported. Each MatchProtocol_T is defined as:
•Classification_T matchTraffic—Specifies the traffic classification. CTM supports the following classifications:
Classification_T.MATCH_ANY
Classification_T.MATCH_DSCP
Classification_T.MATCH_IP
Classification_T.MATCH_COS
string value—This field is a string value. Multiple values should be separated by spaces.
•string class_name—Supported. This field specifies the name of the QoS class.
•QoSPolicer_T policer—Supported. This field specifies the policer to use.
•QoSPolicer_T structure has the following members:
–multiLayerSubnetwork::CIRType_T cir_type—Supported. This specifies the type of CIR, which can either be line rate or rate limited. CTM defines the following values:
–CIRType_T.CIR_RATE
–CIRType_T.CIR_LINE
–long cir—Supported. This field specifies the value of the "cir" and should be in the range of 96 to 800,000 kilobits per second.
–long cir_burst—Supported. This field specifies the value of the "cir burst" and should be in the 8000 to 64000 bytes range.
–multiLayerSubnetwork::COSMarking_T cir_cos—Supported. Specifies the type of CoS marking for the CIR. CTM supports the following values:
–COSMarking_T.COSMARKING_MARK_COS
–COSMarking_T.COSMARKING_TRUST
–long cir_cos_val—Supported. This field specifies the value of CIR CoS value.
–multiLayerSubnetwork::ExcessAction_T excess_act—Supported. CTM supports the following values:
–ExcessAction_T.EXCESS_ACTION_DISCARD
–ExcessAction_T.EXCESS_ACTION_ALLOW
–long pir—Supported. This field specifies the value of the "pir" and should be in the range 96 to 800,000 kilobits per second. It should also be equal to or greater than the cir.
–long pir_burst—Supported. This field specifies the value of the "pir burst" and should be in the 8000 to 64000 bytes range. It should also be equal to or greater than the cir burst.
–multiLayerSubnetwork::COSMarking_T pir_cos—Supported. This field specifies the type of CoS marking for PIR. CTM supports the following values:
•COSMarking_T.COSMARKING_MARK_COS
•COSMarking_T.COSMARKING_TRUST
–long pir_cos_value—Supported. This field specifies the value of the "pir cos."
–multiLayerSubnetwork::ViolateAction_T violate_act—Supported. CTM supports the following values:
–ViolateAction_T.VIOLATE_ACTION_DISCARD
–ViolateAction_T.VIOLATE_ACTION_ALLOW
–long violate_cos_val—Supported. This field specifies the value for "violated cos."
–multiLayerSubnetwork::BesteffortType_T beff_type—Supported. CTM supports the following values for best effort type:
•BestEffortType_T.BEST_EFFORT_RATE
•BestEffortType_T.BEST_EFFORT_LINE
–long beff_rate—Supported. This field specifies the maximum rate of best effort and should be in the range of 96 to 800,000 kilobits per second.
–long beff_rate_burst—Supported. This field should be in the 8000 to 64000 bytes range.
•multiLayerSubnetwork::MatchOption_T operator—Supported. CTM supports the following Match option:
in notifications::ProbableCauseList_T excludeProbCauseList,
in notifications::PerceivedSeverityList_T excludeSeverityList,
in unsigned long how_many
out notifications::EventList_T eventList,
out notifications::EventIterator_I eventIt)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to request all of the cleared and acknowledged alarms that are under the control of this EMS (both those raised by the NEs and those raised by the EMS itself). Some alarms may be filtered out (excluded) by specifying their probable causes or severities.
Due to performance concerns, this operation is restricted to enable only one OSS client to access it at one time. Otherwise, CTM throws EXCPT_UNABLE_TO_COMPLY exception.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH
The ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH do not send a "clear" for TCA events. Therefore, TCAs are not reported in the eventList that is returned by this method.
ONS 15540, ONS 15530, and ONS 15501
TCAs are also reported in the eventList that is returned by this method as ONS 15540 sends a "clear" for threshold crossing alarms.
Parameters
Name
Type
Input/Output
Description
excludeProbCauseList
notifications::ProbableCauseList_T
In
List of probable alarm causes to exclude from the output event list.
excludeSeverityList
notifications::PerceivedSeverityList_T
In
List of alarm severities to exclude from the output event list.
how_many
unsigned long
In
Maximum number of alarms to report in the first batch.
EventList
notifications::EventList
Out
First batch of alarms.
EventIt
notifications::EventIterator_I
Out
Iterator to retrieve the remaining alarms.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_UNABLE_TO_COMPLY - Raised when this method is being used by another OSS Client.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators has reached
128.
in notifications::PerceivedSeverityList_T excludeSeverityList,
in unsigned long how_many
out notifications::EventList_T eventList,
out notifications::EventIterator_I eventIt)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to request all of the cleared and acknowledged alarms that are for the EMS itself. Some alarms may be filtered out (excluded) by specifying their severities.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
Parameters
Name
Type
Input/Output
Description
excludeSeverityList
notifications::PerceivedSeverityList_T
In
List of alarm severities to exclude from the output event list.
how_many
unsigned long
In
Maximum number of alarms to report in the first batch.
EventList
notifications::EventList
Out
First batch of alarms.
EventIt
notifications::EventIterator_I
Out
Iterator to retrieve the remaining alarms.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators has reached
128.
Compliance
CTM-defined.
3.3.19 emsMgr::EMSMgr_I::createServerTrailLink
Synopsis
void createServerTrailLink(
in serverTrailLink::STLCreateData_T createData
out serverTrailLink::ServerTrailLink_T serverTrailLink)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to create a server trail link manually between two MEs. CTM supports the server trail link creation between MEs belonging to the same multilayer subnetwork. CTM generates an object creation event notification when a new server trail link is created.
Note STLCreateData_T is a CTM-defined data structure. TMF has proposed this structure and is included in the TMF 3.0 specifications.
Note CTM creates the server trail link between two CTPs even if there are no existing physical link connections in the network.
Parameters
Name
Type
Input/Output
Description
createData
serverTrailLink::STLCreateData_T
In
Data structure containing details for creating a new server trail link.
serverTrailLink
serverTrailLink::ServerTrailLink_T
Out
Created server trail link information.
CTM support for STLCreateData_T structure is as follows:
•string userLabel
Not supported. The value of this field is assigned to the name of the newly created server trail link.
•boolean forceUniqueness
Not supported.
•string owner
Not supported.
•globaldefs::ConnectionDirection_T direction
CTM supports only CD_BI for bidirectional links.
•transmissionParameters::LayerRate_T rate
Supported layer rates are:
–LR_STS1_and_AU3_High_Order_VC3
–LR_STS3c_and_AU4_VC4
–LR_STS12c_and_VC4_4c
–LR_STS24c_and_VC4_8c
–LR_STS48c_and_VC4_16c
–LR_STS192c_and_VC4_64c
•globaldefs::NamingAttributes_T aEndCTP
Supported.
•globaldefs::NamingAttributes_T zEndCTP
Supported.
•globaldefs::NVSList_T additionalCreationInfo
Supported. The supported parameters are listed in the table below.
ManagedElement Type
Parameter Name
Supported Parameter Values
All ManagedElements which support ServerTrailLink
serverTrailLinkProtectionType
PREEMPTIBLE, UNPROTECTED, FULLY_PROTECTED.
All ManagedElements which support ServerTrailLink
linkCost
Int, 1 - 2147483647.
All ManagedElements which support ServerTrailLink
linkCount
Int, 1 - 1024.
•globaldefs::sSrlgGroupList_T srlgGroupListValue
Supported. This field holds the SRLG group values. This is an optional parameter you can include in the SRLG group during the Link creation. A maximum of five SRLG groups are supported for a given Link. SRLG groups are only supported for SONET/SDH server trail links.
CTM support for ServerTrailLink_T structure is as follows:
•globaldefs::NamingAttributes_T name
Supported. This field will have two tuples. The first tuple is for EMS. The second one is for ServerTrailLink. The value in the second tuple is the same as the nativeEMSName field.
•string userLabel
Not supported.
•boolean forceUniqueness
Not supported
•string owner
Not supported.
•globaldefs::ConnectionDirection_T direction
CTM supports only CD_BI for bidirectional links.
•transmissionParameters::LayerRate_T rate
Supported layer rates are:
–LR_STS1_and_AU3_High_Order_VC3
–LR_STS3c_and_AU4_VC4
–LR_STS12c_and_VC4_4c
–LR_STS24c_and_VC4_8c
–LR_STS48c_and_VC4_16c
–LR_STS192c_and_VC4_64c
•globaldefs::NamingAttributes_T aEndTP
Supported. The CTP for the serverTrailLink aEnd.
•globaldefs::NamingAttributes_T zEndTP
Supported. The CTP for the serverTrailLink zEnd.
•globaldefs::NVSList_T additionalCreationInfo
Supported. The supported parameters are listed in the table below.
ManagedElement Type
Parameter Name
Supported Parameter Values
All ManagedElements that support ServerTrailLink
serverTrailLinkProtectionType
PREEMPTIBLE, UNPROTECTED, FULLY_PROTECTED.
All ManagedElements that support ServerTrailLink
linkCost
int, 1 - 2147483647.
All ManagedElements that support ServerTrailLink
linkCount
int, 1 - 1024.
•globaldefs::sSrlgGroupList_T srlgGroupListValue
Supported. This field holds the SRLG group values. This is an optional parameter you can include in the SRLG group during the link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH server trail links.
Throws
globaldefs::ProcessingFailureException
EXCPT_INVALID_INPUT - Raised if input createData is not valid.
EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
Compliance
CTM-defined.
3.3.20 emsMgr::EMSMgr_I::deleteServerTrailLink
Synopsis
void deleteServerTrailLink(
in globaldefs::NamingAttributes_T serverTrailLinkName)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to delete a server trail link manually between two MEs. CTM throws the EXCPT_UNABLE_TO_COMPLY exception if the server trail link cannot be deleted in the current state. CTM generates an object deletion event notification when a server trail link is deleted.
Parameters
Name
Type
Input/Output
Description
serverTrailLinkName
globaldefs::NamingAttributes_T
In
Name of the server trail link to delete.
Throws
globaldefs::ProcessingFailureException
EXCPT_INVALID_INPUT - Raised if input the server trail link name is invalid.
EXCPT_ENTITY_NOT_FOUND - Raised if the specified server trail link name does not exist in
CTM.
EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_UNABLE_TO_COMPLY - Raised if attempt is made to delete a server trail which cannot
be deleted.
Compliance
CTM-defined.
3.3.21 emsMgr::EMSMgr_I::addNetworkPartition
Synopsis
void addNetworkPartition(
in string name, in string description)
raises(globaldefs::ProcessingFailureException);
Description
This API enables the OSS to add a new network partition.
This operation allows the NMS to add a new multilayer subnetwork. Upon successful addition, the EMS generates an object creation event for the multilayer subnetwork object.
Parameters
Name
Type
Input/Output
Description
subnetCreateData
MultiLayerSubnetworkCreateData _T
In
MultiLayerSubnetwork input data.
The structure for MultiLayerSubnetworkCreateData _T is as follows:
struct MultiLayerSubnetworkCreateData_T
{
globaldefs::NamingAttributes_T subnetworkName;
string userLabel;
string nativeEMSName;
string owner;
multiLayerSubnetwork::Topology_T subnetworkType;
globaldefs::NVSList_T additionalInfo ;
};
The description of each parameter is as follows:
Name
Type
Description
subnetworkName
globaldefs::NamingAttributes_T
New subnet partition name.
userLabel
string
User label.
nativeEMSName
string
EMS name.
owner
string
Owner.
subnetworkType
multiLayerSubnetwork::Topology_T
Subnetwork topology.
additionalInfo
globaldefs::NVSList_T
The NMS uses the additionalInfo attribute to communicate to the EMS any other information required to create the multiLayerSubnetwork.
This method returns a list of all of the models that the EMS supports. A model's structure has the following form:
•name = "ModelName"
•value = meModel
Parameters
Name
Type
Input/Output
Description
supportedMEs
NVSList_THolder
Out
List of all of the supported model names.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure
Compliance
CTM-defined.
3.4 emsSession::EmsSession_I
The emsSession module enables the client to query the EMS to determine the manager interfaces the EMS is supporting. The NMS retrieves an instance of the needed manager interface objects. This interface is inherited from session::Session_I.
interface EmsSession_I:session::Session_I
3.4.1 emsSession::EmsSession_I::getEventChannel
Synopsis
void getEventChannel(
out CosNotifyChannelAdmin::EventChannel eventChannel)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to access the event channel to receive notifications. CTM publishes the name of the notification channel through the naming service. You can use the naming service to get the corresponding object reference.
Parameters
Name
Type
Input/Output
Description
eventChannel
CosNotifyChannelAdmin::EventChannel
Out
Event channel that the NMS uses.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - This exception indicates a non-specific internal EMS failure.
Compliance
TMF-defined.
3.4.2 emsSession::EmsSession_I::getManager
Synopsis
void getManager(
in string managerName,
out common::Common_I managerInterface)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to access the specified manager interface.
Parameters
Name
Type
Input/Output
Description
managerName
string
In
Class or type of manager object that the client wants.
managerInterface
common::Common_I
Out
The actual object returned implements the specified manager interface. However, it is returned as a Common_I object, so the operation can be generic. The client should narrow the returned object to the correct object type.
Throws
globaldefs::ProcessingFailureException
EXCPT_NOT_IMPLEMENTED - This exception indicates that the EMS does not support the
manager.
EXCPT_INTERNAL_ERROR - This exception indicates a non-specific internal EMS failure.
This operation enables an NMS to request the manager interfaces that the EMS implements.
Parameters
Name
Type
Input/Output
Description
supportedManagerList
managerNames_T
Out
List of manager names supported in the form managerName, where managerName is one of the following defined manager strings for CTM:
•EMS
•ManagedElement
•MultiLayerSubnetwork
•EquipmentInventory
•PerformanceManagement
•Maintenance
•Protection
•Software
Throws
None.
Compliance
TMF-defined.
3.5 emsSessionFactory::EmsSessionFactory_I
A single instance of the EmsSessionFactory_I is the entry point to the EMS. The NMS uses this object reference to connect to CTM. This interface implements the version interface and returns the server IDL version. It is inherited from mtnmVersion::Version_I.
This operation enables the NMS to obtain the EmsSession_I object, which contains all managers of the EMS.
CTM allows 4 to 25 concurrent login sessions and as many user profiles as required for configuring the number of concurrent login sessions. See B.8 Location of the Naming Service IOR File, page B-5 to configure the number of concurrent login sessions. The username and password must contain from 1 to 53 characters.
This operation can also accept the encrypted username and password. To enable encryption on the username and password, check the Enable encryption for username and password check box in the CTM client Control Panel for the CTM GateWay/CORBA service. CTM then decrypts the username and password accordingly.
To encrypt the username and password, you must use the RSA algorithm with the public key or the public key pair provided by CTM. To obtain the CTM public key, use the emsSessionFactory::EmsSessionFactory_I::getEmsPublicKey API. To obtain the CTM public key pair, use the emsSessionFactory::EmsSessionFactory_I::getEmsPublicKeyPair API.
Parameters
Name
Type
Input/Output
Description
user
string
In
The user or application that is trying to access the server. This user must have a profile created in CTM.
password
string
In
Password for the user application.
client
nmsSession::NmsSession_I
In
Handle to the NMS NmsSession_I object, to which the returned EmsSession_I object must be associated.
emsSessionInterface
emsSession::EmsSession_I
Out
CORBA Interoperable Object Reference (IOR) for the EmsSession_I interface.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of a non-specific internal EMS failure.
EXCPT_INVALID_INPUT - Raised when client is invalid or when the length of User name or
Password passed is not within the permissible limits (1-53).
EXCPT_ACCESS_DENIED - Raised in the following cases:
This operation enables the NMS to obtain the string representation of the RSA public key encoded in the Base64 encoding scheme. The operation encrypts the username and password from the string representation of the RSA public key.
The OSS client must use the Base64 decoders to decode the public key and get the byte[] of the public key from the decoded public key string. The byte[] corresponding to the public key represents the key in its primary encoded format; in this case, X.509 SubjectPublicKeyInfo.
You can create the RSA public key using this byte array and cryptographic libraries. Use this key to encrypt the username and password. Bouncy Castle Provider is an example of a security provider that you can use to create the RSApublic key.
The public key is then used to encrypt the username and password. Before passing the encrypted password to CTM for login, the OSS client must encode the encrypted username and password using the Base64 encoder to get the string equivalent of the encrypted data.
Parameters
Name
Type
Input/Output
Description
publicKey
string
Out
Public key string returned by CTM.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
This operation enables the NMS to obtain the string representation of the RSA public key pair (in the modulus and exponent forms) from CTM for encrypting the username and password.
The OSS client must convert the string representation of the public key modulus and public key exponent into a nonnegative integer and create an RSA public key using cryptographic libraries. Crypto++ is one of the security providers available.
Before passing the encrypted password to CTM for login, the OSS client must use the Base64 encoder to encode the encrypted username and password. This provides the string equivalent of the encrypted data.
Parameters
Name
Type
Input/Output
Description
publicKeyModulus
string
Out
Public key modulus string returned by CTM.
publicKeyExponent
string
Out
Public key exponent string returned by CTM.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
Compliance
CTM-defined.
3.6 equipment::EquipmentInventoryMgr_I
This interface accesses operations that deal with equipment. A handle to an instance of this interface is gained through the getManager operation in emsSession. This interface is inherited from common::Common_I.
This interface implements the getCapabilities method. Operations described in the following sections are returned to the NMS when it invokes getCapabilities.
This operation enables an NMS to request all of the equipment and equipment holders contained in a managed element or equipment holder.
Parameters
Name
Type
Input/Output
Description
meOrHolderName
globaldefs::NamingAttributes_T
In
Name of the ME or equipment holder for which to retrieve contained equipment and equipment holders.
how_many
unsigned long
In
Maximum number of EquipmentOrHolder_Ts to return in the first batch.
eqList
EquipmentOrHolderList_T
Out
First batch of EquipmentOrHolder_Ts.
eqIt
EquipmentOrHolderIterator_I
Out
Iterator used to retrieve the remaining EquipmentOrHolder_Ts.
The EqList parameter contains a sequence of the EquipmentOrHolder_T data type, which is defined as the union of Equipment_T and EquipmentHolder_T.
CTM support for Equipment_T is as follows:
•globaldefs::NamingAttributes_T name
–Supported. This field has four tuples. The first tuple is for EMS, the second is for ManagedElement, the third is for EquipmentHolder, and the fourth contains Equipment. The value of the fourth tuple is the same as the value in the nativeEMSName field.
1These cards occupy two slots and can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.
1These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.
1These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.
1These cards occupy two slots and can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.
1These cards occupy two slots and can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.
1These cards occupy two slots and can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.
1These cards occupy two slots and can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.
1These cards occupy two slots and can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.
1This constraint applies if the shelf contains a module of the specified kind. If the shelf does not contain such a module, any other supported module (see D.18 Equipment List for ONS 15800 and ONS 15801, page D-37) can be inserted into the slot.
1This constraint applies if the shelf contains a module of the specified kind. If the shelf does not contain such a module, any other supported module (see D.18 Equipment List for ONS 15800 and ONS 15801, page D-37) can be inserted into the slot.
1This constraint applies if the shelf contains a module of the specified kind. If the shelf does not contain such a module, any other supported module (see D.19 Equipment List for ONS 15808, page D-39) can be inserted into the slot.
out terminationPoint::TerminationPointList_T tpList,
out terminationPoint::TerminationPointIterator_I tpIt)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables an NMS to request the PTPs that are directly supported by specific equipment. The PTPs that are returned are those that share their physical layer with the primary equipment (that is, they represent a port on the equipment or are connected by a fiber, wire, and so on).
If the equipment is protection equipment in a 1_FOR_N protection group, CTM reports only the AlarmReporting for the LayeredParameters of the supported PTPs.
•ONS 15454 SONET: CTM returns OC-n, DS1, DS3, EC-1, fibre channel, and front Ethernet ports.
•ONS 15454 SDH: CTM returns STM-n (OC-n), E1, E3, DS3I, STM1E, fibre channel, and front Ethernet ports.
•ONS 15327: CTM returns OC-n, DS1, DS3, and Ethernet ports.
•ONS 15800, ONS 15801, and ONS 15808: CTM returns all the supported PTPs for specific ONS 158xx equipment.
•ONS 15540: CTM returns all the client, wave, wavepatch, filter, wdm, filterband, filtergroup, oscfilter, wavepassthrough, fastEthernet, TenGigEthernetPhy, and sonet-sdh as potential PTPs.
•ONS 15530: CTM returns all the supported PTPs for ONS 15530.
•ONS 15501: CTM returns In-Port and Out-Port.
•ONS 15216: CTM returns all the supported PTPs for ONS 15216, if there is a topological link associated with the NE.
•ONS 15600 SONET: CTM returns OC-n ports.
•ONS 15600 SDH: CTM returns STM-n ports.
•ONS 15302, ONS 15305, and ONS 15305 CTC: CTM returns WAN, SDH, and PDH ports.
•ONS 15310 CL and ONS 15310 MA: CTM returns OC-n, DS1, DS3, and Ethernet ports.
•CRS-1 and XR 12000: CTM returns the line cards ports (POS, POS/SDH, and GE).
•MGX 8880/8850/8830: CTM returns the physical service module cards ports (DS1, DS3, and SONET/SDH).
Parameters
Name
Type
Input/Output
Description
equipmentName
globaldefs::NamingAttributes_T
In
Name of the equipment for which to retrieve supported PTPs.
how_many
unsigned long
In
Maximum number of PTPs to report in the first batch.
tpList
terminationPoint::TerminationPointList_T
Out
First batch of PTPs.
tpIt
terminationPoint::TerminationPointIterator_I
Out
Iterator used to retrieve the remaining PTPs.
CTM support for TerminationPoint_T structure is as follows:
–Supported. Layer rate is supported for PTP, CTP, and FTP.
CTM supports the following parameters for PTP.
TP Type
NE Type
Valid Values
Supporting Equipment and Restrictions
AlarmReporting
PTP
ONS 15310 CL
ONS 15310 MA
ONS 15327
ONS 15454 SONET
ONS 15454 SDH
ONS 15600 SONET
ONS 15600 SDH
On, Off
All equipment (except equipment that does not have PTP, such as XC, XCVT, TCC2, CXC, and so on).
ServiceState
PTP
ONS 15310 CL
ONS 15310 MA
ONS 15327
ONS 15454 SONET
ONS 15454 SDH
ONS 15600 SONET
ONS 15600 SDH
—
All equipment (except ML100T, ML1000, FCMR, ML2_L2L3, ML2_MAPPER, CE-100T-8, and equipment that does not have PTP, such as XC, XCVT, TCC2, and so on).
AdminState
PTP
ONS 15310 CL
ONS 15310 MA
ONS 15327
ONS 15454 SONET
IN_SERVICE, OUT_OF_SERVICE, OUT_OF_SERVICE_BY_MAINTENANCE (for NE R3.4.1 or later), AUTO_IN_SERVICE (for NE R3.4.1 or later)
Down, Up
All equipment (except ML100T, ML1000, and equipment that does not have PTP, such as XC, XCVT, TCC2, and so on). G1000_4, G1000_2, and FCMR do not support the AUTO_IN_SERVICE value.
Down and Up are valid values shown for ML-series cards (ML100T, ML1000, and ML-FX).
For CE-series and E-series Ethernet cards, valid values are In Service, Auto In Service, Out of Service, and Out of Service by Maintenance.
SERV_NA is not a valid value for any card.
ONS 15600
IN_SERVICE, OUT_OF_SERVICE_BY_MAINTENANCE, OUT_OF_SERVICE (for NE R5.0 or later), AUTO_IN_SERVICE (for NE R5.0 or later)
All equipment (except equipment that does not have PTP, such as CXC and so on).
ONS 15454 SDH
ONS 15600 SDH
UNLOCKED
LOCKED, DISABLED
LOCKED, MAINTENANCE
UNLOCKED, AUTO_IN_SERVICE
All equipment (except ML100T, ML1000, and equipment that does not have PTP, such as XC, XCVT, TCC2, CXC and so on). FCMR does not support the UNLOCKED, AUTO_IN_SERVICE value.
LOCKED, DISABLED and UNLOCKED, AUTO IN SERVICE are not supported by the ONS 15600 SDH.
LineCode
PTP
ONS 15310 CL
ONS 15310 MA
ONS 15327
ami, b8zs
DS1 port on XTC card and CTX card.
ONS 15454 SONET
ami, b8zs
DS1, DS1N.
ONS 15310 CL
ONS 15310 MA
ONS 15454 SONET
b3zs
DS3E, DS3NE, DS3XM, DS3I, DS3IN,DS3, DS1-84/DS3-EC1-3, DS1-28/DS3-EC1-3, ONS 15310 CL and ONS 15310 MA DS3 ports on CTX cards.
ONS 15454 SDH
hdb3
E1, E1N, E1_42.
ONS 15454 SDH
b3zs
DS3I, DS31N.
FrameFormat
PTP
ONS 15310 CL
ONS 15310 MA
ONS 15327
esf, d4, unframed, auto provision fmt (only on ONS 15310)
DS1 port on XTC cards.
ONS 15454 SONET
esf, d4, unframed
DS1, DS1N.
ONS 15454 SONET
m13 (for NE R4.0 and later), m23 (for NE R3.4.1 and earlier), cbit, unframed, auto provision fmt
DS3E, DS3NE, DS3I, DS31N, DS3.
ONS 15454 SONET
m13 (for NE R4.0 and later), m23 (for NE R3.4.1 and earlier), cbit
DS3XM.
ONS 15454 SDH
e1_mf, e1_crcmf, e1_unframed
E1, E1N, E1_42.
ONS 15310 CL
ONS 15310 MA
m13, cbit, unframed
DS3 port on CTX cards.
ONS 15454 SDH
m13 (for NE R4.0 and later), m23 (for NE R3.4.1), cbit, unframed, auto provision fmt
This operation enables an NMS to request the equipment that contains this PTP.
Parameters
Name
Type
Input/Output
Description
ptpName
globaldefs::NamingAttributes_T
In
Name of the PTP for which to retrieve supporting equipment.
eqList
EquipmentOrHolderList_T
Out
List of equipment (not equipment holders) that directly implements the PTP.
EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as a union of Equipment_T and EquipmentHolder_T structures. For further details on both structures, see equipment::EquipmentInventoryMgr_I::getAllEquipment.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when ptpName does not reference a PTP object.
EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references a PTP object that does not exist.
EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators has reached
128.
in globaldefs::NamingAttributes_T equipmentHolderName,
out EquipmentOrHolderList_T equipmentOrHolderList)
raises(globaldefs::ProcessingFailureException);
Description
This operation returns the equipment and equipment holders that a specific equipment holder contains. This operation differs from getAllEquipment in that it looks only at the next level of the containment hierarchy.
Parameters
Name
Type
Input/Output
Description
equipmentHolderName
globaldefs::NamingAttributes_T
In
Name of the equipment holder for which to retrieve the directly contained equipment and equipment holders.
CTM also accepts the ME name as a value for this parameter.
equipmentOrHolderList
EquipmentOrHolderList_T
Out
The directly contained equipment and equipment holders.
EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as a union of Equipment_T and EquipmentHolder_T structures. For further details on both structures, see equipment::EquipmentInventoryMgr_I::getAllEquipment.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when equipmentHolderName does not reference an equipment
holder object.
EXCPT_ENTITY_NOT_FOUND - Raised when equipmentHolderName references an equipment holder
that does not exist.
EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.
This operation 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 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, CTM 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 detects new equipment and provisions it automatically, provided that the equipment holder (slot) is empty and 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, CTM 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, CTM 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
equipmentCreateData
EQTCreateData_T
In
Data that describes the equipment to create.
createdEquipment
Equipment_T
Out
Resulting created equipment.
CTM support for EQTCreateData_T structure is as follows:
in globaldefs::NamingAttributes_T equipmentOrHolderName)
raises(globaldefs::ProcessingFailureException);
Description
This operation enables alarm reporting on a piece of equipment.
The default setting for alarmReporting is "on." If the alarmReporting status is off, it indicates that a warning alarm has been raised for it. CTM generates a cleared warning alarm if successful.
Parameters
Name
Type
Input/Output
Description
equipmentOrHolderName
globaldefs::NamingAttributes_T
In
Equipment on which to activate alarm reporting.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference an equipment or
holder.
EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object that does
not exist.
EXCPT_UNABLE_TO_COMPLY - Raised when alarm reporting cannot be disabled for the equipment
or holder.
EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.
This operation 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 its related objects, such as termination points.
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 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 one 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.
ONS 15454 reserves Slot 7 and 11 for TCC. One of these slots will have an IN SERVICE TCC card. If the NMS invokes unprovisionEquipment on this equipment, CTM throws the EXCPT_UNABLE_TO_COMPLY exception.
Parameters
Name
Type
Input/Output
Description
equipmentName
globaldefs::NamingAttributes_T
In
Name of the equipment to unprovision.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of non-specific 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.
in globaldefs::NamingAttributes_T equipmentOrHolderName,
in globaldefs::NVSList_T paramList
raises(globaldefs::ProcessingFailureException);
Description
This operation enables provisioning of fast Ethernet and POS configuration parameters on the ML cards. The operation is performed on a best-effort basis and CTM does not validate the parameter names and the values being passed to the API.
If the operation is unsuccessful, CTM returns a processing failure exception.
This operation enables the user to configure the following POS parameters:
Overview of APIs Supported by NE Type
