Class SubnetworkConnection {Analysis} derived from: CommonResourceInfo

Documentation
A Subnetwork Connection relates end-point TPs or GTPs. All end point TPs related by an SNC must support the same or an equivalent layer rate which is also the SNC's layer rate. A SNC provides a transparent end-to-end connection or a trail (closed or half-open) through a Subnetwork according to the roles associated to its end points. If it represents a connection, its end points are Connection Termination Points (CTPs) or Floating Termination Points (FTPs) with the SNC's layer rate as connectable layer rate. If it represents a trail, its end points are CTPs or FTPs or Physical Termination Points (PTPs).
In pending state, generic connection termination point(s) of the SNC could be replied.
Refer to the associated supporting document snctypes for explanation of SNC Properties, SNC Parameters, unidirectional SNCs, Point-to-Multipoint SNC, Routing Constraints and Route Discovery.
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 NMS, using methods on the containing Subnetwork object, or by EMS.
Object Creation Notification Issued? Yes
Object Deletion Notification Issued? Yes
Object Discovery Notification Issued? Yes
External Documents

SD1-36_SNCTypes.pdf | SD2-11_IA-SS_Mapping.xls

Parent Package | Logical View | Abstract | No
Export Control | PublicAccess | Link Class for | is a reliable TP of
Class Kind | NormalClass | Cardinality | n
Space |  | Concurrency | Sequential
Persistence | No |  |

Operations

Name | Signature | Class
getRoute | void getRoute (CIS Boolean includeHigherOrderCCs = False, Route route = NA) | SubnetworkConnection
setAlarmReportingOn | void setAlarmReportingOn () | SubnetworkConnection
setAlarmReportingOff | void setAlarmReportingOff () | SubnetworkConnection
getRouteAndTopologicalLinks | void getRouteAndTopologicalLinks (Route route = NA, CIS SequenceOf TopologicalLink topologicalLinkList = NA) | SubnetworkConnection
getBackupRoutes | void getBackupRoutes (Name routeId = NA, CIS Boolean includeHigherOrderCCs = False, CIS SequenceOf Structs::AVP additionalInfo = empty list, CIS SequenceOf Route routeList = empty list) | SubnetworkConnection
switchRoute | void switchRoute (Name routeId = NA, GradesOfImpact tolerableImpact = MINOR_IMPACT, FreedomLevel emsFreedomLevel = CREATE_CONNECTION_AT_SNC_LAYER, CIS SequenceOf TPData tpsToModify = empty list, CIS SequenceOf Structs::AVP additionalInfo = empty list, SNCState sncState = NA, CIS CharacterString errorReason = empty string) | SubnetworkConnection
addRoute | void addRoute (RouteCreateData createRouteData = NA, GradesOfImpact tolerableImpact = MINOR_IMPACT, FreedomLevel emsFreedomLevel = CREATE_CONNECTION_AT_SNC_LAYER, Route theRoute = NA, CIS CharacterString errorReason = empty string) | SubnetworkConnection
removeRoute | void removeRoute (Name routeId = NA, FreedomLevel emsFreedomLevel = CREATE_CONNECTION_AT_SNC_LAYER, CIS SequenceOf Structs::AVP additionalInfo = empty list) | SubnetworkConnection
setIntendedRoute | void setIntendedRoute (Name routeId = NA, CIS SequenceOf Structs::AVP additionalInfo = empty list) | SubnetworkConnection
getIntendedRoute | void getIntendedRoute (Route theRoute = NA, CIS SequenceOf Structs::AVP additionalInfo = empty list) | SubnetworkConnection
setRoutesAdminState | void setRoutesAdminState (CIS SequenceOf Structs::RouteNameAndAdminState routeNameAndAdminStateList = NA, SNCState sncState = NA) | SubnetworkConnection
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 | SubnetworkConnection | ConnectionDirection | NA
rate | SubnetworkConnection | LayerRate | NA
staticProtectionLevel | SubnetworkConnection | StaticProtectionLevel | NA
sncState | SubnetworkConnection | SNCState | NA
rerouteAllowed | SubnetworkConnection | RerouteAllowed | NA
networkRouted | SubnetworkConnection | NetworkRouted | NA
networkReroute | SubnetworkConnection | Reroute | Not_Set
sncType | SubnetworkConnection | SNCType | NA
networkAccessDomain | SubnetworkConnection | CIS CharacterString | empty string
alarmReportingIndication | SubnetworkConnection | CIS Boolean | FALSE
correlationId | SubnetworkConnection | CIS CharacterString | empty string
bundledSNCIndicator | SubnetworkConnection | CIS Boolean | FALSE
mustRemoveGTPs | SubnetworkConnection | CIS Boolean | NA
fixed | SubnetworkConnection | CIS Boolean | NA
revertive | SubnetworkConnection | CIS Boolean | NA
priority | SubnetworkConnection | CIS Integer | 0
retainOldSNC | SubnetworkConnection | CIS Boolean | NA
asapPointer | SubnetworkConnection | Name | CIS Null
aEndPointsRole | SubnetworkConnection | CIS SequenceOf Structs::EndPointRole | NA
zEndPointsRole | SubnetworkConnection | CIS SequenceOf Structs::EndPointRole | NA
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-- | SubnetworkConnection | --Not Named-- | MultiLayerSubnetwork
is characterized by | --Not Named-- | SubnetworkConnection | --Not Named-- | Route
--Not Named-- | sncExclusions | SubnetworkConnection | --Not Named-- | SNCCreateData
--Not Named-- | --Not Named-- | SubnetworkConnection | aEnd | GroupTerminationPoint
--Not Named-- | --Not Named-- | SubnetworkConnection | zEnd | GroupTerminationPoint
--Not Named-- | sncExclusion | SubnetworkConnection | --Not Named-- | RouteCreateData
--Not Named-- | --Not Named-- | SubnetworkConnection | --Not Named-- | AlarmSeverityAssignmentProfile
--Not Named-- | --Not Named-- | SubnetworkConnection | aEnd | TerminationPoint
--Not Named-- | --Not Named-- | SubnetworkConnection | zEnd | TerminationPoint

Dependencies

Name | Class | Supplier
reports | SubnetworkConnection | ObjectInformation
generates | SubnetworkConnection | AlarmInformation
create Route with | SubnetworkConnection | RouteCreateData
--Not Named-- | SubnetworkConnection | TopologicalLink

Generalization Relationships

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