SAFplus Runtime Director API  3.0.5
aspAmfEntity.AmfServiceUnit Class Reference

Class that models a SAF Service Unit. More...

Inheritance diagram for aspAmfEntity.AmfServiceUnit:
Collaboration diagram for aspAmfEntity.AmfServiceUnit:

Public Member Functions

def __init__
 
def isRunning
 Return true if this service group is running. More...
 
def isIdle
 Return true if this service group is running. More...
 
def isActive
 Return true if this SU has SIs assigned 'active' to it. More...
 
def isStandby
 Return true if this SU has SIs assigned 'standby' to it. More...
 
def haRole
 Return 'none', 'active', 'standby', or 'active/standby' depending on the roles of SUs on this node. More...
 
- Public Member Functions inherited from aspAmfEntity.AmfEntity
def __init__
 Constructor Parameters: typee: The AMF type of this entity. More...
 
def __cmp__
 The comparison operator simply compares entity names since the AMF mandates that entity names are unique. More...
 
def __hash__
 
def __str__
 
def setInitialState
 Set the initial state of this entity (call before you pass the object to aspAmf) More...
 
def copyLocalState
 Copy the locally kept state in this entity from one entity to another of the same type. More...
 
def setConfig
 
def setState
 
def setStatus
 
def isRunning
 Return true if this entity is running. More...
 
def isProtected
 Return true if this service instance has at least 1 running standby assignment, None if not applicable. More...
 
def isIdle
 Return True if the entity is running but has no assigned work, or None if the concept of 'idle' is not applicable. More...
 
def isOk
 Return True if the entity is 100%. More...
 
def adminState
 Return the administrative status of this entity. More...
 
def enabled
 Return True if this entity is enabled, False if not enabled, or none if not applicable (for example the entity has not been applied into the AMF). More...
 

Public Attributes

 sg
 The SAF AMF service group that owns by this service unit. More...
 
 node
 The node that this Service Unit is configured to run on. More...
 
 si
 List of SAF AMF service instances owned by this service unit. More...
 
 comp
 List of components "owned" by this service unit. More...
 
 rank
 This service unit's rank. More...
 
- Public Attributes inherited from aspAmfEntity.AmfEntity
 type
 SAF AMF type of the entity (see module-global variable that define available types) More...
 
 name
 Name of this entity as known by the AMF. More...
 
 associatedData
 
 initialState
 
 cconfig
 SAF AMF configuration of the entity. More...
 
 cstatus
 

Detailed Description

Class that models a SAF Service Unit.

Essentially a Service Unit is the actualization on a particular node of a SAF Service Group.

Constructor & Destructor Documentation

def aspAmfEntity.AmfServiceUnit.__init__ (   self,
  name,
  sg = None,
  node = None 
)

Member Function Documentation

def aspAmfEntity.AmfServiceUnit.haRole (   self)

Return 'none', 'active', 'standby', or 'active/standby' depending on the roles of SUs on this node.

def aspAmfEntity.AmfServiceUnit.isActive (   self)

Return true if this SU has SIs assigned 'active' to it.

def aspAmfEntity.AmfServiceUnit.isIdle (   self)

Return true if this service group is running.

def aspAmfEntity.AmfServiceUnit.isRunning (   self)

Return true if this service group is running.

def aspAmfEntity.AmfServiceUnit.isStandby (   self)

Return true if this SU has SIs assigned 'standby' to it.

Member Data Documentation

aspAmfEntity.AmfServiceUnit.comp

List of components "owned" by this service unit.

aspAmfEntity.AmfServiceUnit.node

The node that this Service Unit is configured to run on.

aspAmfEntity.AmfServiceUnit.rank

This service unit's rank.

For information about rank ordering, see the SAF AMF spec (www.saforum.org)

aspAmfEntity.AmfServiceUnit.sg

The SAF AMF service group that owns by this service unit.

aspAmfEntity.AmfServiceUnit.si

List of SAF AMF service instances owned by this service unit.