Class MultiLayerSubnetwork {Analysis} derived from: CommonResourceInfo

Documentation
A multi layer subnetwork is an abstraction provided by the EMS to the NMS which describes the potential for subnetwork connections.
Top-level multi layer subnetworks are subnetworks contained directly under either the EMS or a Management Domain object instance.
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 the EMS.
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
createSNC | void createSNC (SNCCreateData sncCreateData = NA, GradesOfImpact tolerableImpact = MINOR_IMPACT, FreedomLevel emsFreedomLevel = CREATE_CONNECTION_AT_SNC_LAYER, SubnetworkConnection snc = NA, CIS CharacterString errorReason = empty string) | MultiLayerSubnetwork
checkValidSNC | void checkValidSNC (SNCCreateData createData = NA, CIS SequenceOf TPData tpsToModify = empty list, CIS Boolean considerResources = True, CIS Boolean valid = NA) | MultiLayerSubnetwork
activateSNC | void activateSNC (Name sncName = NA, GradesOfImpact tolerableImpact = MINOR_IMPACT, FreedomLevel emsFreedomLevel = CREATE_CONNECTION_AT_SNC_LAYER, CIS SequenceOf TPData tpsToModify = empty list, SubnetworkConnection snc = NA, CIS CharacterString errorReason = empty string) | MultiLayerSubnetwork
createAndActivateSNC | void createAndActivateSNC (SNCCreateData sncCreateData = NA, GradesOfImpact tolerableImpact = MINOR_IMPACT, FreedomLevel emsFreedomLevel = CREATE_CONNECTION_AT_SNC_LAYER, CIS SequenceOf TPData tpsToModify = empty list, SubnetworkConnection snc = NA, CIS CharacterString errorReason = empty string) | MultiLayerSubnetwork
deactivateSNC | void deactivateSNC (Name sncName = NA, GradesOfImpact tolerableImpact = MINOR_IMPACT, FreedomLevel emsFreedomLevel = CREATE_CONNECTION_AT_SNC_LAYER, CIS SequenceOf TPData tpsToModify = empty list, SubnetworkConnection snc = NA, CIS CharacterString errorReason = empty string) | MultiLayerSubnetwork
deleteSNC | void deleteSNC (Name sncName = NA, FreedomLevel emsFreedomLevel = CREATE_CONNECTION_AT_SNC_LAYER, CIS CharacterString errorReason = empty string) | MultiLayerSubnetwork
deactivateAndDeleteSNC | void deactivateAndDeleteSNC (Name sncName = NA, GradesOfImpact tolerableImpact = MINOR_IMPACT, FreedomLevel emsFreedomLevel = CREATE_CONNECTION_AT_SNC_LAYER, CIS SequenceOf TPData tpsToModify = empty list, CIS CharacterString errorReason = empty string) | MultiLayerSubnetwork
getAllManagedElements | void getAllManagedElements (CIS SequenceOf ManagedElement mes = NA) | MultiLayerSubnetwork
getAllManagedElementNames | void getAllManagedElementNames (CIS SequenceOf Name meNames = NA) | MultiLayerSubnetwork
getAllTopologicalLinks | void getAllTopologicalLinks (CIS SequenceOf TopologicalLink topologicalLinks = NA) | MultiLayerSubnetwork
getAllTopologicalLinkNames | void getAllTopologicalLinkNames (CIS SequenceOf Name topologicalLinkNames = NA) | MultiLayerSubnetwork
getTopologicalLink | void getTopologicalLink (Name topoLinkName = NA, TopologicalLink topoLink = NA) | MultiLayerSubnetwork
getAllSubnetworkConnections | void getAllSubnetworkConnections (CIS SequenceOf Enums::LayerRate connectionRates = empty list, CIS SequenceOf SubnetworkConnection subnetworkConnections = NA) | MultiLayerSubnetwork
getAllSubnetworkConnectionNames | void getAllSubnetworkConnectionNames (CIS SequenceOf Enums::LayerRate connectionRates = empty list, CIS SequenceOf Name sncNames = NA) | MultiLayerSubnetwork
getAllSubnetworkConnectionsWithTP | void getAllSubnetworkConnectionsWithTP (Name tpName = NA, CIS SequenceOf Enums::LayerRate connectionRates = empty list, CIS SequenceOf SubnetworkConnection subnetworkConnections = NA) | MultiLayerSubnetwork
getAllSubnetworkConnectionNamesWithTP | void getAllSubnetworkConnectionNamesWithTP (Name tpName = NA, CIS SequenceOf Enums::LayerRate connectionRates = empty list, CIS SequenceOf Name sncNames = NA) | MultiLayerSubnetwork
getSNC | void getSNC (Name sncName = NA, SubnetworkConnection subnetworkConnection = NA) | MultiLayerSubnetwork
getAllEdgePoints | void getAllEdgePoints (CIS SequenceOf Enums::LayerRate tpLayerRates = empty list, CIS SequenceOf Enums::LayerRate connectionLayerRates = empty list, CIS SequenceOf TerminationPoint edgeTPs = NA) | MultiLayerSubnetwork
getAllEdgePointNames | void getAllEdgePointNames (CIS SequenceOf Enums::LayerRate tpLayerRates = empty list, CIS SequenceOf Enums::LayerRate connectionLayerRates = empty list, CIS SequenceOf Name edgeTPNames = NA) | MultiLayerSubnetwork
getAssociatedTP | void getAssociatedTP (Name tpName = NA, CIS SequenceOf TerminationPoint associatedTPs = NA) | MultiLayerSubnetwork
getAllTPPools | void getAllTPPools (CIS SequenceOf TPPool tpPools = NA) | MultiLayerSubnetwork
getAllTPPoolNames | void getAllTPPoolNames (CIS SequenceOf Name tpPoolNames = NA) | MultiLayerSubnetwork
getSNCsByUserLabel | void getSNCsByUserLabel (CIS CharacterString userLabel = NA, CIS SequenceOf SubnetworkConnection sncList = NA) | MultiLayerSubnetwork
getAllFixedSubnetworkConnections | void getAllFixedSubnetworkConnections (CIS SequenceOf Enums::LayerRate connectionRates = empty list, CIS SequenceOf SubnetworkConnection subnetworkConnections = NA) | MultiLayerSubnetwork
getAllFixedSubnetworkConnectionNames | void getAllFixedSubnetworkConnectionNames (CIS SequenceOf Enums::LayerRate connectionRates = empty list, CIS SequenceOf Name sncNames = NA) | MultiLayerSubnetwork
getAllFixedSubnetworkConnectionsWithTP | void getAllFixedSubnetworkConnectionsWithTP (Name tpName = NA, CIS SequenceOf Enums::LayerRate connectionRates = empty list, CIS SequenceOf SubnetworkConnection subnetworkConnections = NA) | MultiLayerSubnetwork
getAllFixedSubnetworkConnectionNamesWithTP | void getAllFixedSubnetworkConnectionNamesWithTP (Name tpName = NA, CIS SequenceOf Enums::LayerRate connectionRates = empty list, CIS SequenceOf Name sncNames = NA) | MultiLayerSubnetwork
createModifiedSNC | void createModifiedSNC (Name sncName = NA, CIS CharacterString routeId = empty string, SNCModifyData sncModifyData = NA, FreedomLevel emsFreedomLevel = CREATE_CONNECTION_AT_SNC_LAYER, GradesOfImpact tolerableImpact = MINOR_IMPACT, ProtectionEffort tolerableImpactEffort = SAME, CIS SequenceOf TPData tpsToModify = empty list, SubnetworkConnection newSNC = NA, CIS CharacterString errorReason = empty string) | MultiLayerSubnetwork
swapSNC | void swapSNC (Name sncToBeDeactivated = NA, Name sncToBeActivated = NA, FreedomLevel emsFreedomLevel = CREATE_CONNECTION_AT_SNC_LAYER, GradesOfImpact tolerableImpact = MINOR_IMPACT, CIS SequenceOf TPData tpsToModify = empty list, SNCState stateOfActivatedSNC = NA, CIS CharacterString errorReason = empty string) | MultiLayerSubnetwork
modifySNC | void modifySNC (Name sncName = NA, CIS CharacterString routeId = empty string, SNCModifyData sncModifyData = NA, FreedomLevel emsFreedomLevel = CREATE_CONNECTION_AT_SNC_LAYER, GradesOfImpact tolerableImpact = MINOR_IMPACT, ProtectionEffort tolerableImpactEffort = SAME, CIS SequenceOf TPData tpsToModify = empty list, SubnetworkConnection newSNC = NA, CIS CharacterString errorReason = empty string) | MultiLayerSubnetwork
createTPPool | void createTPPool (TPPoolCreateData newTPPoolCreateData = NA, TPPool newTPPool = NA) | MultiLayerSubnetwork
deleteTPPool | void deleteTPPool (Name tpPoolName = NA) | MultiLayerSubnetwork
modifyTPPool | void modifyTPPool (Name tpPoolName = NA, CIS SequenceOf Name containedMembers = NA, CIS CharacterString actionType = NA, TPPool modifiedTPPool = NA) | MultiLayerSubnetwork
getTPPool | void getTPPool (Name tpPoolName = NA, TPPool tpPool = NA) | MultiLayerSubnetwork
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
subnetworkType | MultiLayerSubnetwork | Topology | NA
supportedRates | MultiLayerSubnetwork | CIS SequenceOf Enums::LayerRate | NA
networkAccessDomain | MultiLayerSubnetwork | CIS CharacterString | empty string
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
manages | --Not Named-- | MultiLayerSubnetwork | --Not Named-- | OperationsSystem
--Not Named-- | --Not Named-- | MultiLayerSubnetwork | --Not Named-- | ManagementDomain
--Not Named-- | --Not Named-- | MultiLayerSubnetwork | --Not Named-- | EMS
--Not Named-- | --Not Named-- | MultiLayerSubnetwork | --Not Named-- | TopologicalLink
--Not Named-- | --Not Named-- | MultiLayerSubnetwork | --Not Named-- | TPPool
associated with | --Not Named-- | MultiLayerSubnetwork | --Not Named-- | ManagedElement
--Not Named-- | --Not Named-- | MultiLayerSubnetwork | --Not Named-- | SubnetworkConnection
bounded by | --Not Named-- | MultiLayerSubnetwork | --Not Named-- | TerminationPoint

Dependencies

Name | Class | Supplier
create SNC with | MultiLayerSubnetwork | SNCCreateData
reports | MultiLayerSubnetwork | ObjectInformation
generates | MultiLayerSubnetwork | AlarmInformation
tpsToModify | MultiLayerSubnetwork | TPData
modify SNC with | MultiLayerSubnetwork | SNCModifyData
create TPPool with | MultiLayerSubnetwork | TPPoolCreateData

Generalization Relationships

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