SAFplus Runtime Director API  3.0.5
aspAmfModify Namespace Reference

Functions

def addWork
 Extend a SG by adding SUs with all the components defined in the SG: More...
 
def updateSgCfg
 Modify the SG's configuration by the values in cfgDict. More...
 
def extendSg
 Extend a SG by adding SUs with all the components defined in the SG. More...
 
def newNode
 Create a new node entity in the AMF. More...
 

Function Documentation

def aspAmfModify.addWork (   sg,
  workName,
  kvdict,
  amfSession = None 
)

Extend a SG by adding SUs with all the components defined in the SG:

Parameters
sgService group name (string) or entity (aspAmfEntity.ServiceGroup) to add the SI to
workNameName of the work (SAF SI) to be created
kvdictDictionary of name/value pairs to put in all of the CSIs
amfSession(optional) aspAmf.Session object used to install the new work into the AMF – if not passed a temporary session will be created
Returns
(newEntities,modifiedEntities) a tuple of 2 lists containing the new and modified entities
def aspAmfModify.extendSg (   sg,
  nodes,
  basename = None,
  index = None,
  amfSession = None 
)

Extend a SG by adding SUs with all the components defined in the SG.

Parameters
sgService group name (string) or entity (aspAmfEntity.ServiceGroup) to extend
nodesA list of strings or entities (aspAmfEntity.Node) onto which you want to extend the SG
basename(optional) The name prefix for the new SUs & other created entities. If None, the SG's basename will be used
index(optional) What number to start the SU name with (eg N in: mySUiN). If None, the number of current SUs will be used
amfSession(optional) aspAmf.Session object used to install the new work into the AMF – if not passed a temporary session will be created
Returns
(newEntities,modifiedEntities) a tuple of 2 lists containing the new and modified entities
def aspAmfModify.newNode (   self,
  nodeInfo 
)

Create a new node entity in the AMF.

Parameters
nodeInfo.A dictionary containing the following fields: name: Name of the node entity slot: What slot (or fake slot) it is in aspdir: Where is ASP installed on this node? localIp: String specifying the intracluster IP address for this node (used in SW deployment) localUser String specifying a valid user on this node (used in SW deployment) localPasswd String specifying the user's password this node (used in SW deployment)
def aspAmfModify.updateSgCfg (   sg,
  cfgDict,
  amfSession = None 
)

Modify the SG's configuration by the values in cfgDict.

Parameters
sgService group name (string) or entity (aspAmfEntity.ServiceGroup) to modify
cfgDictA Dot() object or other entity with SG configuration parameters expressed as member variables. The SG configuration parameters are exactly as written in ClAmsSGConfigT C structure located in clAmsEntities.h
amfSession(optional) aspAmf.Session object used to install the new work into the AMF – if not passed a temporary session will be created
Returns
Nothing