Class TopologicalLink {Analysis} derived from: CommonResourceInfo

Documentation
A Topological Link (TL) is a physical link between two PTPs or a trail between two TPs (e.g., an ATM link between two ATM NI CTPs), which are called aEndTP and zEndTP of the TL.
A TL has a name and references to the two end point TPs.
A Topological Link reported by an EMS to the NMS will usually be between two Managed Elements (MEs) that are managed by the same EMS but need not be adjacent. Depending on the capabilities of the EMS and the MEs, a TL may or may not be autodiscovered by the EMS.
For a TP that is connected outside of the EMS' span of control, if the EMS knows about the remote end, the EMS may provide this information via a single-ended TL, called off-network TL. Such a TL is single-ended since only one end point, namely the aEndTP, belongs to the EMS managing the TL the other ( i.e., the zEndTP) being off-network and being reported as a remote address (and possibly being managed by another EMS).
The end points of a Topological Link may belong to different Subnetworks, in which case it is called top-level TL, or to the same Subnetwork, and then the TL is called inner TL. Top-level topological links are topological links between the top-level subnetworks within either an EMS or a Management Domain instance. The end points of a Topological Link may belong to different Management Domains, in which case it is called inter-MD TL. The end points of a TL may also belong to the same ME, in which case it is called internal TL. An off-network TL is considered as a top-level TL.
The Topological Link may be created/deleted by the NMS and is implemented by the EMS.
A Topological Link may traverse through DWDM equipment and optical transport networks managed by another EMS. The TL reported by the first EMS in that case could correspond to a (regenerator) section under its management domain. It is up to the NMS user to put together the exact topology of the network in such cases, based on the reported MEs and TLs.
For unidirectional TLs the aEndTP marks the traffic source whereas the zEndTP marks the traffic sink.
MTOSI Specific Documentation
This class is applicable to MTOSI. The specific operations and relationships that apply to MTOSI are listed in SD2-11.
For MTOSI, references to "NMS" can be interpreted as "Requesting OS" and references to "EMS" can be interpreted as "Target OS", i.e., the OS that fulfills requests from another OS.
The statements concerning Object Lifecycle, i.e., whether the object can be created by the NMS or EMS, are not particularly meaningful for MTOSI, since MTOSI does not define management systems with fixed roles such as the NMS and EMS entities in MTNM.
Object Lifecycle: Created and deleted by EMS or NMS.
Object Creation Notification Issued? Yes
Object Deletion Notification Issued? Yes
Object Discovery Notification Issued? Yes
External Documents

SD2-11_IA-SS_Mapping.xls |

Parent Package | Logical View | Abstract | No
Export Control | PublicAccess | Link Class for | None
Class Kind | NormalClass | Cardinality | n
Space |  | Concurrency | Sequential
Persistence | No |  |

Operations

Name | Signature | Class
setAlarmReportingOn | void setAlarmReportingOn () | TopologicalLink
setAlarmReportingOff | void setAlarmReportingOff () | TopologicalLink
setNativeEMSName | void setNativeEMSName (Name objectName, CIS CharcaterString nativeEMSName) | CommonResourceInfo
setOwner | void setOwner (Name objectName, CIS CharcaterString owner) | CommonResourceInfo
setUserLabel | void setUserLabel (Name objectName, CIS CharcaterString userLabel, Boolean enforceUniqueness) | CommonResourceInfo
setNetworkAccessDomain | void setNetworkAccessDomain (CIS CharcaterString networkAccessDomain = NA) | CommonResourceInfo
setAdditionalInfo | void setAdditionalInfo (CIS SequenceOf Structs::AVP additionalInfo = empty list) | CommonResourceInfo

Attributes

Name | Class | Type | Initial Value
direction | TopologicalLink | ConnectionDirection | NA
layerRate | TopologicalLink | LayerRate | NA
networkAccessDomain | TopologicalLink | CIS CharacterString | empty string
alarmReportingIndication | TopologicalLink | CIS Boolean | FALSE
asapPointer | TopologicalLink | Name | CIS Null
name | CommonResourceInfo | Name | NA
userLabel | CommonResourceInfo | CIS CharacterString | Value of the nativeEMSName attribute.
owner | CommonResourceInfo | CIS CharacterString | empty string
nativeEMSName | CommonResourceInfo | CIS CharacterString | empty string
discoveredName | CommonResourceInfo | CIS CharacterString | empty string
namingOS | CommonResourceInfo | Name | CIS Null
source | CommonResourceInfo | ObjectSource | UNKNOWN
aliasNameList | CommonResourceInfo | AVP | empty list
resourceState | CommonResourceInfo | ResourceState | UNKNOWN
additionalInfo | CommonResourceInfo | CIS SequenceOf Structs::AVP | empty list

Associations

Name | My Role | My Class | Other Role | Other Element
--Not Named-- | --Not Named-- | TopologicalLink | --Not Named-- | ManagementDomain
manages | --Not Named-- | TopologicalLink | --Not Named-- | OperationsSystem
--Not Named-- | --Not Named-- | TopologicalLink | --Not Named-- | EMS
--Not Named-- | --Not Named-- | TopologicalLink | --Not Named-- | MultiLayerSubnetwork
is terminated by | --Not Named-- | TopologicalLink | aEndTP | TerminationPoint
is terminated by | --Not Named-- | TopologicalLink | zEndTP | TerminationPoint
--Not Named-- | tlInclusions | TopologicalLink | --Not Named-- | SNCCreateData
--Not Named-- | tlExclusions | TopologicalLink | --Not Named-- | SNCCreateData
--Not Named-- | tlExclusion | TopologicalLink | --Not Named-- | RouteCreateData
--Not Named-- | tlInclusion | TopologicalLink | --Not Named-- | RouteCreateData
--Not Named-- | --Not Named-- | TopologicalLink | --Not Named-- | AlarmSeverityAssignmentProfile

Dependencies

Name | Class | Supplier
reports | TopologicalLink | ObjectInformation
generates | TopologicalLink | AlarmInformation

Generalization Relationships

Name | Class | Supplier
--Not Named-- | TopologicalLink | CommonResourceInfo