SAFplus Runtime Director API  3.0.5
aspAmfEntity.AmfServiceGroup Class Reference

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

Inheritance diagram for aspAmfEntity.AmfServiceGroup:
Collaboration diagram for aspAmfEntity.AmfServiceGroup:

Public Member Functions

def __init__
 
def redundancyModel
 Return the redundancy model (integer enum) More...
 
def isRunning
 Return true if this service group is running. More...
 
def isIdle
 Return true if this service group is running but no work is assigned. More...
 
def isProtected
 Return true if this service group has at least 1 running standby Service Unit. More...
 
def activeSu
 Return the active service unit as a ServiceUnit object, or None if there is none. More...
 
def nodes
 Return a list of nodes that this Service Group is configured on. More...
 
def app
 return the application that this SG is running (aspApp.App object) More...
 
def appVer
 return the specific application version instance that this SG is running (aspApp.AppFile object) 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

 su
 List of SAF AMF service units owned by this service group. More...
 
 si
 List of SAF AMF service instances owned by this service group. More...
 
 app
 Reference to the Application (aspApp.App) that this service group is running. More...
 
 appVer
 Reference to the software bundle (aspApp.AppVer) that this service group is running. 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.

A Service Group is essentially a highly available, scalable application (with processes running on many nodes). See SAF docs for more details.

Constructor & Destructor Documentation

def aspAmfEntity.AmfServiceGroup.__init__ (   self,
  name 
)

Member Function Documentation

def aspAmfEntity.AmfServiceGroup.activeSu (   self)

Return the active service unit as a ServiceUnit object, or None if there is none.

def aspAmfEntity.AmfServiceGroup.app (   self)

return the application that this SG is running (aspApp.App object)

def aspAmfEntity.AmfServiceGroup.appVer (   self)

return the specific application version instance that this SG is running (aspApp.AppFile object)

def aspAmfEntity.AmfServiceGroup.isIdle (   self)

Return true if this service group is running but no work is assigned.

def aspAmfEntity.AmfServiceGroup.isProtected (   self)

Return true if this service group has at least 1 running standby Service Unit.

def aspAmfEntity.AmfServiceGroup.isRunning (   self)

Return true if this service group is running.

def aspAmfEntity.AmfServiceGroup.nodes (   self)

Return a list of nodes that this Service Group is configured on.

def aspAmfEntity.AmfServiceGroup.redundancyModel (   self)

Return the redundancy model (integer enum)

Member Data Documentation

aspAmfEntity.AmfServiceGroup.app

Reference to the Application (aspApp.App) that this service group is running.

Use of this variable requires that an applicaton database (aspApp.AppDb) has been created and connected to the clusterinf through the (clusterinfo.ClusterInfo.setAppDb) function. If the service group was not deployed via a bundle (for example it is intrinsic to the model – that is, IDE configured), or the application database is not created and connected, then this variable will be None

aspAmfEntity.AmfServiceGroup.appVer

Reference to the software bundle (aspApp.AppVer) that this service group is running.

Use of this variable requires that an applicaton database (aspApp.AppDb) has been created and connected to the clusterinf through the (clusterinfo.ClusterInfo.setAppDb) function. If the service group was not deployed via a bundle (for example it is intrinsic to the model – that is, IDE configured), or the application database is not created and connected, then this variable will be None

aspAmfEntity.AmfServiceGroup.si

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

aspAmfEntity.AmfServiceGroup.su

List of SAF AMF service units owned by this service group.