Network

Network : public class

Created:	3/12/2005 12:00:00 AM
Modified:	7/31/2007 11:19:18 AM

Project:
Author:	AutoMagic KB LLC
Version:	6.2
Phase:	SID
Status:	Approved
Complexity:	Medium
Advanced:
UUID:	{B80FC830-7926-4760-ACC6-E9E9F8D1DAE2}
Appears In:	Resource Generalization Tree, Fig 5LR-43 - First Attempt at Defining a Network, Fig 5LR-47 - Network Class Subclasses, Fig 5LR-82 - Network Biz Model, Fig 5LR-41 - Mapping network AccessDomain to the SID, Fig 5LR-46 - Network Composite Classes, Fig 5LR-48 - Policy Management of Network Entities, Fig 5LR-59 - AutonomousSystem Biz Model, Fig 5LR-69 - IPSubnet Biz Model, Fig 5LR-70 - LAN Biz Diagram, Fig 5LR-71 - LayerNetwork Diagram, Fig 5LR-84 - ResourceElement Biz Model, Fig 5LR-86 - SubNetwork Biz Model, FigXXX - SID-MTNM Transport Integration, ResourcePort Programming

Copyright TM Forum 2006 The Network class is derived from M.3100; DEN-ng has enhanced this definition by providing additional semantics that enable objects defined in the ITU to interact with objects defined in the IETF and the TMF. A Network is a managed object that represents an aggregation of interconnected telecommunications and management objects capable of exchanging information. The reason that a Network is subclassed from ResourceCollection is that it is important that a Network be able to represent physical as well as logical characteristics and behavior of this collection of telecommunications and management objects. A Network has the additional semantics of having one or more common characteristics and/or behavior. For example, a network may be owned by a single customer or provider, or be associated with the delivery of a specific set of services. A network may be nested within another (larger) network, thereby forming a containment relationship. An example of a network that is contained in another network is a transmission sub-network. It is owned by a single Administration and can only perform transmission functions. The m.3100 SystemTitle attribute is NOT implemented in this class, we're using UserLabel instead. Note that the LocationName attribute of m.3100 and MTNM is NOT implemented in this class, but rather is defined through an association to the Location object class in order to represent more generic types of associations. The MTNM managedElementName, nativeEMSName, communucationState, and emsInSyncState attributes are NOT implemented in this class, as all SHOULD be derived from the ManagedDevices association. Note that there can be multiple EMSes that manage any given ManagedElement. The MTNM owner attribute is NOT implemented in this class, as it is derived from the MEOwner association. Note that there can be multiple owners for any given ManagedElement. The MTNM connectionRate attribute is NOT implemented in this class, as not all ManagedElements have the ability to communicate. The MTNM softwareVersion attribute is NOT implemented in this class, as not all ManagedElements have software associated with them.

Attributes
Operations
Associations To
Associations From
Other Links

Attribute

Details

public Integer
networkAdministrativeState

Notes:

This attribute is an enumerated integer that defines the administrative state of the Network. Values include: 0: Unknown 1: Unlocked 2: Locked 3: Shutting Down 4: Starting Up 5: Testing 6: Maintenance

public Integer
networkAlarmStatus

Notes:

This is an enumerated integer that indicates the occurrence of an abnormal condition relating to one or more managed objects that are contained in this Network. This attribute may also function as a summary indicator of alarm conditions associated with a specific resource. It is used to indicate the existence of an alarm condition, a pending alarm condition such as threshold situations, or (when used as a summary indicator) the highest severity of active alarm conditions. Values include: 0: unknown error 1: active - Critical 2: active - Major 3: active - Minor 4: active - Indeterminate 5: active - Warning 6: active - PendingDecision 7: active - UnderRepair 8: active - BeingReplaced 9: cleared

public Boolean
isNetworkOperational

Notes:

This attribute is used to define the operational status of the Network, and is implemented as a Boolean: TRUE means that the Network is currently operational, and FALSE means that the Network is not currently operational

public SequenceOf String
layerRates

Notes:

This is a comma-separated Sequence of string attributes. Each string identifies a communication rate that is supported by this Network

Operation

Details

public
getActiveMaintenanceOps():SequenceOf String

Sequential

Notes:

Copyright TM Forum 2005 This retrieves a listing of all persistent maintenance commands that are currently enabled on this Network.

public
getAllActiveEMSAlarms(

excludeProbCauseList: SequenceOfString,

Default:
Kind:	in
Stereotype:
	The list of probable causes to exclude (for which events should not be reported).

excludeSeverityList: SequenceOfString,

Default:
Kind:	in
Stereotype:
	List of severities to exclude from the output event list.

):SequenceOf AlarmInfo

Sequential

Notes:

Copyright TM Forum 2005 This retrieves all active alarms and TCAs. Alarms that are not reported by the ME to the EMS should not be reported by this operation. A CIS Sequence of Alarms is produced. This operation retrieves only those alarms that would be reported by a ME and sent to an EMS (vs those reported by this ME and sent to an NMS).

public
getAllActiveNMSAlarms(

excludeProbCause: SequenceOfString,

Default:
Kind:	in
Stereotype:
	The list of probable causes to exclude (for which events should not be reported).

excludeSeverityList: SequenceOfString,

Default:
Kind:	in
Stereotype:
	List of severities to exclude from the output event list.

):SequenceOf AlarmInfo

Sequential

Notes:

Copyright TM Forum 2005 This returns all active alarms and TCAs. Alarms that are not reported by the ME to the NMS should not be reported by this operation. A CIS Sequence of Alarms is produced. This operation returns only those alarms that exist at the NML, which would traditionally be reported by an ME and sent to an NMS.

public
getAllCTPs(

ctpLayerRates: SequenceOf String,

Default:
Kind:	in
Stereotype:
	This defines a list of TP Layer Rates used to scope the request. If the list is empty, all CTPs are returned.

connectionLayerRates: SequenceOf String,

Default:
Kind:	in
Stereotype:
	This defines the set of connection layer rates from which the reported CTPs must support at least one. If the list is empty then all CTPs are returned.

):SequenceOf TerminationPoint

sequential

Notes:

Copyright TM Forum 2005 This returns a filtered set of the CTPs and their associated distinguishing information that are contained in this network. The two arguments act as a filter, enabling only those CTPs to be returned that contain one or more of the layer and/or connection rates.

public
getAllEdges():Sequence of PhysicalPort

sequential

Notes:

Copyright TM Forum 2005 This method returns a comma-separated Sequence of PhysicalPort objects that represent the edges in this Network.

public
getAllEquipment(

equipmentType: Integer,

Default:
Kind:	in
Stereotype:
	Fine Grain implementation specific. This is an enumerated integer with the following semantics: 1: return all Equipment and EquipmentHolders 2: return all Equipment but no EquipmentHolders 3: return all EquipmentHolders but no Equipment

):SequenceOf ManagedPhysicalEntity

sequential

Notes:

Copyright TM Forum 2005 This operation returns all Equipment or EquipmentHolders contained in this Network in a CIS sequence.

public
getAllPhysicalPorts(

connectionLayerRates: SequenceOf String,

Default:
Kind:	in
Stereotype:
	This defines the set of connection layer rates from which the reported CTPs must support at least one. If the list is empty then all CTPs are returned.

portType: SequenceOf String,

Default:
Kind:	in
Stereotype:
	This is a set of PhysicalPort types that can be used to filter this request. If the list is empty, all PhysicalPorts are returned.

):SequenceOf TerminationPoint

sequential

Notes:

Copyright TM Forum 2005 This operation retrieves a filtered set of the PhysicalPorts and their associated distinguishing information that are contained in this network. The arguments act as a filter, enabling only those PhysicalPorts to be returned that are of a specific type and that are capable of containing CTPs that can be connected at one or more of the specified connection layer rates.

public
getAllPipes(

TypeOfPipe: Integer,

Default:
Kind:	in
Stereotype:
	This argument specifies the type of Pipe that is to be returned. Values include: 0: All Pipes (Connections and Trails) 1: Connections Only 2: Trails Only

):SequenceOf Pipe

sequential

Notes:

Copyright TM Forum 2005 This method returns a Sequence of Pipes (e.g., Connections and/or Trails) that are contained in this Network.

public
getSpecificEquipment(

equipmentType: Integer,

Default:
Kind:	in
Stereotype:
	This attribute is defined by Fine Grain, and has the following semantics: 1: search for Equipment using CommonName 2: search for Equipment using ObjectID 3: search for EquipmentHolder using CommonName 4: search for EquipmentHolder using ObjectID

):ManagedPhysicalEntity

sequential

Notes:

Element	Source Role	Target Role	Details
NetworkComposite Class	Name:	Name:	<p>Copyright TM Forum 2006<br/></p><p><br/></p><p>This aggregation defines the set of Networks that are present in this particular NetworkComposite.<br/></p>

Element	Source Role	Target Role	Details
PhysicalPort Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This aggregation defines the set of PhysicalPorts that exist in a particular Network. While the cardinality looks a bit strange, realize that in the case of an OSPF area, an edge router, or many other examples, a device can belong to multiple networks.<br/></p>
PhysicalResource Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This aggregation defines the set of PhysicalResources that make up this Network.<br/></p>
LogicalResource Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This aggregation defines the set of LogicalResources that make up this Network.<br/></p>

Object	Type	Connection	Notes
PhysicalPort	Class	Weak	Copyright TM Forum 2005 This aggregation defines the set of PhysicalPorts that exist in a particular Network. While the cardinality looks a bit strange, realize that in the case of an OSPF area, an edge router, or many other examples, a device can belong to multiple networks.
PhysicalResource	Class	Weak	Copyright TM Forum 2005 This aggregation defines the set of PhysicalResources that make up this Network.
ResourceCollection	Class	Tree
NetworkComposite	Class	Weak	Copyright TM Forum 2006 This aggregation defines the set of Networks that are present in this particular NetworkComposite.
NetworkComposite	Class	Tree
NetworkAtomic	Class	Tree
LogicalResource	Class	Weak	Copyright TM Forum 2005 This aggregation defines the set of LogicalResources that make up this Network.