PhysicalDevice

PhysicalDevice : public abstract class

Created:	3/12/2005 12:00:00 AM
Modified:	7/30/2007 10:23:26 AM

Project:
Author:	AutoMagic KB LLC
Version:	6.2
Phase:	SID
Status:	Approved
Complexity:	Medium
Advanced:
UUID:	{ACBB42D9-869A-4e96-AE13-34AEB4C5ACA8}
Appears In:	Resource Generalization Tree, Service Class Diagram, Resource-Service-PartyRole, Fig 5LR-33 - CompoundResource Instance Example, Logical Resource Role Summary, Fig 5PR-05 , Fig 5PR-11 - PhysicalResourceSpec, Fig 5PR-12 - PhysicalDevice, Fig 5PR-13 - Hardware, Fig 5PR-36 - PhysicalResourceSpec Biz Model, Fig 5PR-39 - Hardware Biz Model, Fig 5PR-42 - PhysicalDevice Biz Model, Fig 5PR-43 - PhysicalConnector Biz Model, PhysicalCapacity Summary, PhysicalDeviceRoleSummary, Router, Fig 5PR-06, Fig 5PR-07, Fig 5PR-08

Copyright TM Forum 2005 This is an abstract base class for representing hardware devices that can be managed. This class represents a convenient aggregation point for combining different aspects of a device (e.g., the cables, connectors, cards, power supplies, and other objects that together make up the device). Thus, it enables the device itself to have a physical manifestation (e.g., the "Internet Gateway Router" can be identified as a PhysicalDevice). Examples of this class include routers and switches, computers, and other end-devices that are managed.

Attributes
Operations
Associations To
Associations From
Other Links

Attribute

Details

public Boolean
backplaneIndependent

Notes:

This is a boolean attribute that, if TRUE, indicates that this ManagedDevice has independent backplanes that can be managed separately. This is an optional attribute.

public Integer
backplaneNumber

Notes:

This is an integer that defines the number of backplanes that this device has. This is an optional attribute

public String
configurationOrder

Notes:

This is a free-form string that provides any order-specific instructions for configuring the set of components that together constitute this PhysicalDevice. This is an optional attribute.

public String
deviceGroupID

Notes:

This is a string, and is used to uniquely identify this device as a member of a group of devices. This is an optional attribute.

public Boolean
isComposite

Notes:

This is a Boolean attribute that, if TRUE, means that this physical device is in reality made up of a set of physical devices, each of which can be individually managed. This is an optional attribute.

public Boolean
canMixPower

Initial: FALSE

Notes:

This is a Boolean attribute that, if TRUE, means that AC and/or DC power supplies can be used in this device. If it is false, then only one or the other can be used.

Operation

Details

public
configureDevice(

CreateData: SequenceOf String,

Default:
Kind:	in
Stereotype:
	The configuration data for the Equipment. Note that this just provides configuration data, it doesn't immediately change the operation of the Equipment. For that to happen, the loadConfiguration method should be used after this method.

Order: SequenceOf String,

Default:
Kind:	in
Stereotype:
	If a component-specific order of configuration is required, then it is reflected in this argument. If there is no such order, then this argument will be NULL.

):Integer

sequential

Notes:

Copyright TM Forum 2005 This operation allows a process to configure a ManagedDevice. This operation is necessary to transition the ManagedDevice into a functional state. Note that the process may be from Software associated in the ManagedDevice (e.g., from one of its installed Cards) as opposed to an external process. Note, however, that the ManagedDevice will not be operational until a loadDevice method has been successfully executed. This operation returns 0 if successful and a non-zero value if unsuccessful.

public
configureEquipmentInDevice(

Configuration: ,

Default:
Kind:	in
Stereotype:
	A configuration is named and stored as an object, though it may be implemented as a set of objects. This enables configurations to be versioned. This argument is a reference to the specified configuration of the Equipment. Note that this is not necessarily its current configuration.

EquipmentToConfigure: SequenceOf String,

Default:
Kind:	in
Stereotype:
	This argument specifies the Equipment to configure. The Equipment is identified using its unique name. An exception will be thrown if an Equipment can't be found.

):Integer

sequential

Notes:

Copyright TM Forum 2005 This command loads the specified configuration data for the specified Equipment that make up this ManagedDevice. If this method executes successfully, a 0 is returned. Otherwise, a non-zero integer is returned to signal the specific error(s) that were encountered.

public
loadConfiguration(

Configuration: ,

Default:
Kind:	in
Stereotype:
	A configuration is named and stored as an object, though it may be implemented as a set of objects. This enables configurations to be versioned. This argument is a reference to the specified configuration of the Equipment. Note that this is not necessarily its current configuration.

):Integer

sequential

Notes:

Copyright TM Forum 2005 This command loads the specified configuration data for the Equipment. If this method executes successfully, a 0 is returned. Otherwise, a non-zero integer is returned to signal the specific error(s) that were encountered.

public
loadEquipmentConfigurations(

Configuration: ,

Default:
Kind:	in
Stereotype:
	A configuration is named and stored as an object, though it may be implemented as a set of objects. This enables configurations to be versioned. This argument is a reference to the specified configuration of the Equipment. Note that this is not necessarily its current configuration.

EquipmentToConfigure: SequenceOf String,

Default:
Kind:	in
Stereotype:
	This argument specifies the Equipment to configure. The Equipment is identified using its unique name. An exception will be thrown if an Equipment can't be found.

):Integer

sequential

Notes:

Copyright TM Forum 2005 This command loads the specified configuration data for the specified Equipment. If this method executes successfully, a 0 is returned. Otherwise, a non-zero integer is returned to signal the specific error(s) that were encountered.

public
resetDevice():Integer

sequential

Notes:

Copyright TM Forum 2005 This operation allows a process to reset an Equipment. The successful result of this operation is the returning of the Equipment to its initial state prior to any Configuration. This operation will also delete any child objects of the Equipment object. Note that a loadConfiguration command must be given after this operation. This operation returns 0 if successful and a non-zero value if unsuccessful.

public
resetEquipmentInDevice(

EquipmentToConfigure: SequenceOf String,

Default:
Kind:	in
Stereotype:
	This argument specifies the Equipment to reset. The Equipment is identified using its unique name. An exception will be thrown if an Equipment can't be found.

):Integer

sequential

Notes:

Copyright TM Forum 2005 This operation allows a process to reset one or more Equipments in this ManagedDevice (but not the entire ManagedDevice). The successful result of this operation is the returning of the Equipment to its initial state prior to any Configuration. This operation will also delete any child objects of the Equipment object. Note that a configureDevice (or configureEquipmentInDevice), followed by a loadConfiguration command, must both be successfully executed after this operation in order to activate the Equipment and make it operational again. This operation returns 0 if successful and a non-zero value if unsuccessful.

public
setAlarmReporting(

IsEnabled: Boolean,

Default:
Kind:	in
Stereotype:
	When this attribute is TRUE, this operation enables (i.e., activates, or turns on) alarm reporting on this Equipment. When this attribute is FALSE, it disables (i.e., deactivates, or turns off) alarm reporting on this Equipment.

):Integer

sequential

Notes:

Copyright TM Forum 2005 This method is used to enable or disable alarm reporting. Its return type is an Integer so that it can report success or failure of the operation. It has a parameter (IsEnabled) to control whether reporting was enabled or disabled. This operation returns 0 if successful and a non-zero value if unsuccessful.

public
updateConfiguration(

Configuration: ,

Default:
Kind:	in
Stereotype:
	A configuration is named and stored as an object, though it may be implemented as a set of objects. This enables configurations to be versioned. This argument is a reference to the specified configuration of the Equipment. Note that this is not necessarily its current configuration.

):Integer

sequential

Notes:

Copyright TM Forum 2005 This operation allows a process to update a ManagedDevice's configuration. Note that the process may be from Software associated in the Equipment, as opposed to an external process. This operation returns 0 if successful and a non-zero value if unsuccessful.

public
updateConfigurationInDevice(

Configuration: ,

Default:
Kind:	in
Stereotype:
	A configuration is named and stored as an object, though it may be implemented as a set of objects. This enables configurations to be versioned. This argument is a reference to the specified configuration of the Equipment. Note that this is not necessarily its current configuration.

):Integer

sequential

Notes:

Copyright TM Forum 2005 This operation allows a process to update an Equipment's configuration in this ManagedDevice. Note that the process may be from Software associated in the Equipment, as opposed to an external process. This operation returns 0 if successful and a non-zero value if unsuccessful.

Element	Source Role	Target Role	Details
PhysicalDeviceComposite Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This aggregation defines the set of PhysicalDevices that are contained in the associated PhysicalDeviceComposite object. These contained PhysicalDevices can be instances of either the PhysicalDeviceAtomic and/or PhysicalDeviceComposite classes<br/></p>

Element	Source Role	Target Role	Details
PhysicalDeviceRole Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This aggregation defines the set of different roles that a given PhysicalDevice object can have. This version of DEN-ng defines several types of PhysicalDeviceRoles, called PhysicalEncryptionRole, PhysicalFirewallRole, PhysicalRouterRole, and PhysicalSwitchRole. These are certainly not all of the PhysicalDeviceRoles that are possible to define; rather, their definition serves to better understand what is needed of the PhysicalDeviceRole class hierarchy.<br/></p><p><br/></p><p>This aggregation enables PhysicalDevices that have one or more of these functions to be abstracted and modeled using roles.<br/></p>
Hardware Class	Name:	Name:	<p>Copyright TM Forum 2005<br/></p><p><br/></p><p>This aggregation represents the set of hardware that is required to physically construct a ManagedDevice. This is an aggregation, not a composition, because a PhysicalDevice can contain non-critical elements that can be removed without impairing the basic functionality of the PhysicalDevice.<br/></p>

Object	Type	Connection	Notes
PhysicalDeviceRole	Class	Weak	Copyright TM Forum 2005 This aggregation defines the set of different roles that a given PhysicalDevice object can have. This version of DEN-ng defines several types of PhysicalDeviceRoles, called PhysicalEncryptionRole, PhysicalFirewallRole, PhysicalRouterRole, and PhysicalSwitchRole. These are certainly not all of the PhysicalDeviceRoles that are possible to define; rather, their definition serves to better understand what is needed of the PhysicalDeviceRole class hierarchy. This aggregation enables PhysicalDevices that have one or more of these functions to be abstracted and modeled using roles.
PhysicalDeviceAtomic	Class	Tree
PhysicalDeviceComposite	Class	Weak	Copyright TM Forum 2005 This aggregation defines the set of PhysicalDevices that are contained in the associated PhysicalDeviceComposite object. These contained PhysicalDevices can be instances of either the PhysicalDeviceAtomic and/or PhysicalDeviceComposite classes
PhysicalDeviceComposite	Class	Tree
Hardware	Class	Weak	Copyright TM Forum 2005 This aggregation represents the set of hardware that is required to physically construct a ManagedDevice. This is an aggregation, not a composition, because a PhysicalDevice can contain non-critical elements that can be removed without impairing the basic functionality of the PhysicalDevice.
PhysicalResource	Class	Tree