API Reference Pages

Defines, Structures, Typedefs, Functions. More...

Files
file	clAmsErrors.h
	Header file of error Messages that are AMS specific.
file	clAmsMgmtClientApi.h
	Header file of AMS related APIs.

Macros
#define	CL_AMS_ERR_BAD_CONFIG   0x105
	Invalid AMF configuration.
#define	CL_AMS_ERR_CSI_NOT_ASSIGNABLE   0x10a
	The component service instance cannot be assigned an active HA state.
#define	CL_AMS_ERR_ENTITY_NOT_ENABLED   0x104
	The entity state is invalid w.r.t to the requested operation.
#define	CL_AMS_ERR_INVALID_ARGS   0x106
	Invalid arguments.
#define	CL_AMS_ERR_INVALID_COMP   0x100
	The component is invalid.
#define	CL_AMS_ERR_INVALID_ENTITY   0x101
	The AMS entity (node, service group, service unit, service instance, component or component service instance) is invalid.
#define	CL_AMS_ERR_INVALID_ENTITY_LIST   0x103
	The entity list name is invalid.
#define	CL_AMS_ERR_INVALID_ENTITY_STATE   0x102
	The administrative state of an entity (node, service group, service unit or service instance) is invalid.
#define	CL_AMS_ERR_INVALID_OPERATION   0x107
	The requested operation is (currently) invalid.
#define	CL_AMS_ERR_OPERATION_FAILED   0x108
	The requested operation could not be completed.
#define	CL_AMS_ERR_SI_NOT_ASSIGNABLE   0x109
	The service instance cannot be assigned an active HA state.
#define	CL_AMS_ERR_UNMARSHALING_FAILED   0x10b
	Unmarshalling of the AMS buffer failed.
#define	CL_AMS_RC(ERROR_CODE)   CL_RC(CL_CID_AMS, (ERROR_CODE))
	Error macro definitions for AMS.

Functions
ClRcT	clAmsMgmtCCBCommit (CL_IN ClAmsMgmtCCBHandleT ccbHandle)
	Applies the operation specific to CCB context in AMS DB atomically.
ClRcT	clAmsMgmtCCBCSIDeleteNVP (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *csiName, CL_IN ClAmsCSINVPT *nvp)
	Deletes a name value pair for a CSI.
ClRcT	clAmsMgmtCCBCSISetNVP (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *csiName, CL_IN ClAmsCSINVPT *nvp)
	Sets or creates a name value pair for a CSI.
ClRcT	clAmsMgmtCCBDeleteCSIDependency (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *csiName, CL_IN ClAmsEntityT *dependencyCSIName)
	Deletes a CSI from the CSI dependencies list for an AMS CSI.
ClRcT	clAmsMgmtCCBDeleteNodeDependency (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *nodeName, CL_IN ClAmsEntityT *dependencyNodeName)
	Deletes a node from the node dependencies list of an AMS node.
ClRcT	clAmsMgmtCCBDeleteNodeSUList (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *nodeName, CL_IN ClAmsEntityT *suName)
	Removes a SU from the SU list of an AMS node.
ClRcT	clAmsMgmtCCBDeleteSGSIList (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *sgName, CL_IN ClAmsEntityT *siName)
	Deletes a SI from the SI list of an AMS SG.
ClRcT	clAmsMgmtCCBDeleteSGSUList (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *sgName, CL_IN ClAmsEntityT *suName)
	Deletes a SU from the SU list of an AMS SG.
ClRcT	clAmsMgmtCCBDeleteSICSIList (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *siName, CL_IN ClAmsEntityT *csiName)
	Removes a CSI from the CSI list for an AMS SI.
ClRcT	clAmsMgmtCCBDeleteSIDependency (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *siName, CL_IN ClAmsEntityT *dependencySIName)
	Deletes a SI from the SI dependencies list for an AMS SI.
ClRcT	clAmsMgmtCCBDeleteSISURankList (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *siName, CL_IN ClAmsEntityT *suName)
	Removes a SU from the SU rank list for an AMS SI.
ClRcT	clAmsMgmtCCBDeleteSUCompList (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *suName, CL_IN ClAmsEntityT *compName)
	Removes a component from the component list of an AMS SU.
ClRcT	clAmsMgmtCCBEntityCreate (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN const ClAmsEntityT *entity)
	Creates a new instance of an AMS entity.
ClRcT	clAmsMgmtCCBEntityDelete (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN const ClAmsEntityT *entity)
	Deletes an instance of an AMS entity from AMS database.
ClRcT	clAmsMgmtCCBEntitySetConfig (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityConfigT *entityConfig, CL_IN ClUint64T bitMask)
	Sets one or more scalar attributes of an AMS entity.
ClRcT	clAmsMgmtCCBFinalize (CL_IN ClAmsMgmtCCBHandleT ccbHandle)
	Finalizes the AMS management control library.
ClRcT	clAmsMgmtCCBInitialize (CL_IN ClAmsMgmtHandleT amlHandle, CL_OUT ClAmsMgmtCCBHandleT *ccbHandle)
	Initializes the AMS management control library.
ClRcT	clAmsMgmtCCBSetCSIDependency (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *csiName, CL_IN ClAmsEntityT *dependencyCSIName)
	Adds a CSI in the CSI dependencies list for an AMS CSI.
ClRcT	clAmsMgmtCCBSetNodeDependency (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *nodeName, CL_IN ClAmsEntityT *dependencyNodeName)
	Adds a node to the node dependencies list of an AMS node.
ClRcT	clAmsMgmtCCBSetNodeSUList (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *nodeName, CL_IN ClAmsEntityT *suName)
	Adds a SU to the SU list of an AMS node.
ClRcT	clAmsMgmtCCBSetSGSIList (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *sgName, CL_IN ClAmsEntityT *siName)
	Adds a SI to the SI list of an AMS SG.
ClRcT	clAmsMgmtCCBSetSGSUList (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *sgName, CL_IN ClAmsEntityT *suName)
	Adds a SU to the SU list of an AMS SG.
ClRcT	clAmsMgmtCCBSetSICSIList (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *siName, CL_IN ClAmsEntityT *csiName)
	Adds a CSI in the CSI list for an AMS SI.
ClRcT	clAmsMgmtCCBSetSIDependency (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *siName, CL_IN ClAmsEntityT *dependencySIName)
	Adds a SI in the SI dependencies list for an AMS SI.
ClRcT	clAmsMgmtCCBSetSISURankList (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *siName, CL_IN ClAmsEntityT *suName)
	Adds a SU in the SU rank list for an AMS SI.
ClRcT	clAmsMgmtCCBSetSUCompList (CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *suName, CL_IN ClAmsEntityT *compName)
	Adds a component to the component list of an AMS SU.
ClAmsCompConfigT *	clAmsMgmtCompGetConfig (CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
	Returns the configuration information for a component.
ClAmsCompStatusT *	clAmsMgmtCompGetStatus (CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
	Returns the current status information of a component.
ClAmsCSIConfigT *	clAmsMgmtCompServiceInstanceGetConfig (CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
	Returns the configuration information for a component service instance.
ClAmsCSIStatusT *	clAmsMgmtCompServiceInstanceGetStatus (CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
	Returns the current status information of a component service instance.
ClRcT	clAmsMgmtDebugDisable (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity, CL_IN ClUint8T debugFlags)
	Disables debugging for AMS entitity(ies).
ClRcT	clAmsMgmtDebugDisableLogToConsole (CL_IN ClAmsMgmtHandleT amsHandle)
	Disables display of AMS debugging messages on the console.
ClRcT	clAmsMgmtDebugEnable (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity, CL_IN ClUint8T debugFlags)
	Enables debugging for AMS entitity(ies).
ClRcT	clAmsMgmtDebugEnableLogToConsole (CL_IN ClAmsMgmtHandleT amsHandle)
	Enables AMS debugging messages to be displayed on the console.
ClRcT	clAmsMgmtDebugGet (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity, CL_OUT ClUint8T *debugFlags)
	Returns the debugging flags for AMS entitity(ies).
ClRcT	clAmsMgmtEntityGet (CL_IN ClAmsMgmtHandleT handle, CL_INOUT ClAmsEntityRefT *entityRef)
	Returns the configuration and status scalar attributes of an AMS entity.
ClRcT	clAmsMgmtEntityGetConfig (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *entity, CL_OUT ClAmsEntityConfigT **entityConfig)
	Returns the configuration scalar attributes of an AMF entity.
ClRcT	clAmsMgmtEntityGetStatus (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *entity, CL_OUT ClAmsEntityStatusT **entityStatus)
	returns the status (transient) scalar attributes of an AMS entity
ClRcT	clAmsMgmtEntityLockAssignment (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity)
	Changes the administrative state of an AMS entity to lock assigned state.
ClRcT	clAmsMgmtEntityLockInstantiation (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity)
	Changes the administrative state of an AMS entity to lock instantiated state.
ClRcT	clAmsMgmtEntityRepaired (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity)
	Marks a previously faulty entity as repaired, so that AMS can use it again for work assignment.
ClRcT	clAmsMgmtEntityRestart (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity)
	Restart an AMS entity following termination .
ClRcT	clAmsMgmtEntitySetAlphaFactor (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN ClAmsEntityT *entity, CL_IN ClUint32T alphaFactor)
	Changes the alpha factor configured for a given SG.
ClRcT	clAmsMgmtEntitySetBetaFactor (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN ClAmsEntityT *entity, CL_IN ClUint32T betaFactor)
	Changes the beta factor configured for a given SG.
ClRcT	clAmsMgmtEntityShutdown (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity)
	Changes the administrative state of an AMS entity to shutting-down.
ClRcT	clAmsMgmtEntityUnlock (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity)
	Changes the administrative state of an AMS entity to unlocked state.
ClRcT	clAmsMgmtEntityUserDataDelete (ClAmsMgmtHandleT handle, ClAmsEntityT *entity)
	Deletes the data for the default key associated with an AMF entity.
ClRcT	clAmsMgmtEntityUserDataDeleteAll (ClAmsMgmtHandleT handle, ClAmsEntityT *entity)
	Deletes all the data associated with an AMF entity for all keys.
ClRcT	clAmsMgmtEntityUserDataDeleteKey (ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClNameT *key)
	Deletes the arbitrary data associated with an AMF entity and a key.
ClRcT	clAmsMgmtEntityUserDataGet (ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClCharT **data, ClUint32T *len)
	Retrieve arbitrary data associated with an AMF entity.
ClRcT	clAmsMgmtEntityUserDataGetKey (ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClNameT *key, ClCharT **data, ClUint32T *len)
	Retrieve arbitrary data associated with an AMF entity and a key.
ClRcT	clAmsMgmtEntityUserDataSet (ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClCharT *data, ClUint32T len)
	Associate arbitrary data with an AMF entity.
ClRcT	clAmsMgmtEntityUserDataSetKey (ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClNameT *key, ClCharT *data, ClUint32T len)
	Associate arbitrary data with an AMF entity and a key.
ClRcT	clAmsMgmtFinalize (CL_IN ClAmsMgmtHandleT amsHandle)
	Terminates the use of the management function library.
ClRcT	clAmsMgmtGetCompCSIList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *comp, CL_OUT ClAmsCompCSIRefBufferT *csiBuffer)
	returns the list of csi's assigned to a component
ClRcT	clAmsMgmtGetCompList (CL_IN ClAmsMgmtHandleT handle, CL_OUT ClAmsEntityBufferT *entityBuffer)
	Get all component entity names.
ClRcT	clAmsMgmtGetCSIDependenciesList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *csi, CL_OUT ClAmsEntityBufferT *dependenciesCSIBuffer)
	returns the csi-csi dependencies list for a csi
ClRcT	clAmsMgmtGetCSIList (CL_IN ClAmsMgmtHandleT handle, CL_OUT ClAmsEntityBufferT *entityBuffer)
	Get all component service instance entity names.
ClRcT	clAmsMgmtGetCSINVPList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *csi, CL_OUT ClAmsCSINVPBufferT *nvpBuffer)
	returns the name value pair list for a csi
ClRcT	clAmsMgmtGetList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityListTypeT listName, CL_OUT ClAmsEntityBufferT *buffer)
	Get all entities of a particular type.
ClRcT	clAmsMgmtGetNodeDependenciesList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *node, CL_OUT ClAmsEntityBufferT *dependencyBuffer)
	returns the node dependencies list for a node
ClRcT	clAmsMgmtGetNodeList (CL_IN ClAmsMgmtHandleT handle, CL_OUT ClAmsEntityBufferT *entityBuffer)
	Get all node entity names.
ClRcT	clAmsMgmtGetNodeSUList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *node, CL_OUT ClAmsEntityBufferT *suBuffer)
	returns the node su list for a node
ClRcT	clAmsMgmtGetSGAssignedSUList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *assignedSUBuffer)
	returns the assigned su list for a sg
ClRcT	clAmsMgmtGetSGFaultySUList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *faultySUBuffer)
	returns the faulty su list for a sg
ClRcT	clAmsMgmtGetSGInServiceSpareSUList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *inserviceSpareSUBuffer)
	returns the in service spare su list for a sg
ClRcT	clAmsMgmtGetSGInstantiableSUList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *instantiableSUBuffer)
	returns the instantiable su list for a sg
ClRcT	clAmsMgmtGetSGInstantiatedSUList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *instantiatedSUBuffer)
	returns the instantiated su list for a sg
ClRcT	clAmsMgmtGetSGList (CL_IN ClAmsMgmtHandleT handle, CL_OUT ClAmsEntityBufferT *entityBuffer)
	Get all service group names.
ClRcT	clAmsMgmtGetSGSIList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *siBuffer)
	returns the sg si list for a sg
ClRcT	clAmsMgmtGetSGSUList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *suBuffer)
	returns the sg su list for a sg
ClRcT	clAmsMgmtGetSICSIList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *si, CL_OUT ClAmsEntityBufferT *csiBuffer)
	returns the si-csi list for a si
ClRcT	clAmsMgmtGetSIDependenciesList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *si, CL_OUT ClAmsEntityBufferT *dependenciesSIBuffer)
	returns the si-si dependencies list for a si
ClRcT	clAmsMgmtGetSIList (CL_IN ClAmsMgmtHandleT handle, CL_OUT ClAmsEntityBufferT *entityBuffer)
	Get all service instance entity names.
ClRcT	clAmsMgmtGetSISUList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *si, CL_OUT ClAmsSISURefBufferT *suBuffer)
	returns the su list for si
ClRcT	clAmsMgmtGetSISURankList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *si, CL_OUT ClAmsEntityBufferT *suBuffer)
	returns the si-su rank list for a si
ClRcT	clAmsMgmtGetSUAssignedSIsList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *su, CL_OUT ClAmsSUSIRefBufferT *siBuffer)
	returns the assigned si's list for su
ClRcT	clAmsMgmtGetSUCompList (CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *su, CL_OUT ClAmsEntityBufferT *compBuffer)
	returns the component list for a su
ClRcT	clAmsMgmtGetSUList (CL_IN ClAmsMgmtHandleT handle, CL_OUT ClAmsEntityBufferT *entityBuffer)
	Get all service unit entity names.
ClRcT	clAmsMgmtInitialize (CL_OUT ClAmsMgmtHandleT *amsHandle, CL_IN const ClAmsMgmtCallbacksT *amsMgmtCallbacks, CL_INOUT ClVersionT *version)
	Starts the use of the management function library.
ClRcT	clAmsMgmtMigrateSG (ClAmsMgmtHandleT handle, const ClCharT *sg, const ClCharT *prefix, ClUint32T activeSUs, ClUint32T standbySUs, ClAmsMgmtMigrateListT *migrateList)
	Convert an SG from one redundancy model to another, without taking it offline.
ClAmsNodeConfigT *	clAmsMgmtNodeGetConfig (CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
	Returns the configuration information for nodes.
ClAmsNodeStatusT *	clAmsMgmtNodeGetStatus (CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
	Returns the current status information of a node.
ClAmsSGConfigT *	clAmsMgmtServiceGroupGetConfig (CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
	Returns the configuration information for a service group.
ClAmsSGStatusT *	clAmsMgmtServiceGroupGetStatus (CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
	Returns the current status information of a service group.
ClAmsSIConfigT *	clAmsMgmtServiceInstanceGetConfig (CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
	Returns the configuration information for a service instance.
ClAmsSIStatusT *	clAmsMgmtServiceInstanceGetStatus (CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
	Returns the current status information of a service instance.
ClAmsSUConfigT *	clAmsMgmtServiceUnitGetConfig (CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
	Returns the configuration information for a service unit.
ClAmsSUStatusT *	clAmsMgmtServiceUnitGetStatus (CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
	Returns the current status information of a service unit.
ClRcT	clAmsMgmtSetActive (ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClAmsEntityT *activeSU)
	Changes the 'Active' Service Unit.
ClRcT	clAmsMgmtSGAdjust (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClCharT *sg, CL_IN ClBoolT enable)
	Restores the SG to the most preferred assignments.
ClRcT	clAmsMgmtSISwap (CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClCharT *si)
	Swaps the HA state of the appropriate CSIs contained within an SI.

Detailed Description

Defines, Structures, Typedefs, Functions.

Macro Definition Documentation

#define CL_AMS_ERR_INVALID_ARGS   0x106

Invalid arguments.

(Mostly used in AMF debug CLI)

#define CL_AMS_ERR_INVALID_ENTITY_LIST   0x103

The entity list name is invalid.

(Used by AMS management APIs.)

Function Documentation

ClRcT clAmsMgmtCCBCommit

(

CL_IN ClAmsMgmtCCBHandleT

ccbHandle

)

Applies the operation specific to CCB context in AMS DB atomically.

Header File:

clAmsMgmtClientApi.h

Parameters

ccbHandle

(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.

Description:

The clAmsMgmtCCBCommit() API atomically carries out the previously specified AMS management control set operation(s) on the AMS DB. Applications must invoke this call ideally after they have called all the management control set APIs for the sets to take effect.

After calling clAmsMgmtCCBCommit() the handle can be reused for another transaction. To abort the transaction instead of committing, use clAmsMgmtCCBFinalize().

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBInitialize(), clAmsMgmtCCBFinalize()

ClRcT clAmsMgmtCCBCSIDeleteNVP	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	csiName,
		CL_IN ClAmsCSINVPT *	nvp
	)

Deletes a name value pair for a CSI.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
csiName	(in) The name of the CSI.
nvp	(in) The name value pair for the CSI to be deleted.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_NOT_EXIST	The CSI specified by the csiName doesn't exist in AMS database.

Description:

This API deletes a name value pair of the component service instance.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBCSISetNVP()

ClRcT clAmsMgmtCCBCSISetNVP	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	csiName,
		CL_IN ClAmsCSINVPT *	nvp
	)

Sets or creates a name value pair for a CSI.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
csiName	(in) The name of the CSI.
nvp	(in) The name value pair to be set/created.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.

Description:

This API sets a name value pair for the component service instance. If the name value pair specified does not already exist for the CSI, then AMS creates the name value pair.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBCSIDeleteNVP()

ClRcT clAmsMgmtCCBDeleteCSIDependency	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	csiName,
		CL_IN ClAmsEntityT *	dependencyCSIName
	)

Deletes a CSI from the CSI dependencies list for an AMS CSI.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
csiName	(in) Name of the CSI whose dependency list is being modified.
dependencyCSIName	(in) Name of the dependent CSI to be removed from the CSI's dependencies list.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The CSI specified by the csiName doesn't exist in AMS database.

Description:

This API allows removing one CSI at a time from the dependency list of a particular CSI.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBDeleteCSIDependency()

ClRcT clAmsMgmtCCBDeleteNodeDependency	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	nodeName,
		CL_IN ClAmsEntityT *	dependencyNodeName
	)

Deletes a node from the node dependencies list of an AMS node.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
nodeName	(in) Name of the node whose dependency list is being modified.
dependencyNodeName	(in) Name of the dependent node to be removed from the node's dependencies list.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The node specified by the nodeName doesn't exist in AMS database.

Description:

This API allows removing one node at a time from the dependency list of a particular node.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBSetNodeDependency()

ClRcT clAmsMgmtCCBDeleteNodeSUList	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	nodeName,
		CL_IN ClAmsEntityT *	suName
	)

Removes a SU from the SU list of an AMS node.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
nodeName	(in) Name of the node whose SU list is being modified.
suName	(in) Name of SU to be removed from the SU list of the node.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The node specified by the nodeName doesn't exist in AMS database.

Description:

This API allows us to remove one SU at a time from the su list of a node. By removing an SU to SU list of a node, we are destroying a containment relation that the SU represented by suName is contained in the node nodeName.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBSetNodeSUList()

ClRcT clAmsMgmtCCBDeleteSGSIList	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	sgName,
		CL_IN ClAmsEntityT *	siName
	)

Deletes a SI from the SI list of an AMS SG.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
sgName	(in) Name of the SG whose SI list is being modified.
siName	(in) Name of SI that is removed from the SI list of the SG.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The SG specified by the sgName doesn't exist in AMS database.

Description:

This API allows us to remove one SI at a time from the SI list of a SG. By removing an SI from SI list of a SG, we are destroying a containment relation that the SI represented by siName is contained (protected by) in the SG sgName for the purposes of carrying out high availability functions.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBSetSGSIList()

ClRcT clAmsMgmtCCBDeleteSGSUList	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	sgName,
		CL_IN ClAmsEntityT *	suName
	)

Deletes a SU from the SU list of an AMS SG.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
sgName	(in) Name of the SG whose SU list is being modified.
suName	(in) Name of SU that is removed from the SU list of the SG.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The SG specified by the sgName doesn't exist in AMS database.

Description:

This API allows us to remove one SU at a time from the SU list of a SG. By removing an SU from SU list of a SG, we are destroying a containment relation that the SU represented by suName is contained (protected by) in the SG sgName for the purposes of carrying out high availability functions like switchover/failover etc.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBSetSGSUList()

ClRcT clAmsMgmtCCBDeleteSICSIList	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	siName,
		CL_IN ClAmsEntityT *	csiName
	)

Removes a CSI from the CSI list for an AMS SI.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
siName	(in) Name of the SI whose CSI list is being modified.
csiName	(in) Name of CSI that is being removed from the CSI list of the SI.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The SI specified by the siName doesn't exist in AMS database.

Description:

This API allows us to remove one CSI at a time from the CSI list of a SI. By adding an CSI to CSI list of a SI, we are destroying a containment relation that the CSI csiName is contained in the SI siName for the purposes of carrying out high availability functions like fault escalation etc.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBSetSICSIList()

ClRcT clAmsMgmtCCBDeleteSIDependency	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	siName,
		CL_IN ClAmsEntityT *	dependencySIName
	)

Deletes a SI from the SI dependencies list for an AMS SI.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
siName	(in) Name of the SI whose dependency list is being modified.
dependencySIName	(in) Name of the dependent SI to be removed from the SI's dependencies list.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The SI specified by the siName doesn't exist in AMS database.

Description:

This API allows removing one SI at a time from the dependency list of a particular SI.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBSetSIDependency()

ClRcT clAmsMgmtCCBDeleteSISURankList	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	siName,
		CL_IN ClAmsEntityT *	suName
	)

Removes a SU from the SU rank list for an AMS SI.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
siName	(in) Name of the SI whose SU rank list is being modified.
suName	(in) Name of SU that is removed from the SU rank list of the SI.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The SI specified by the siName doesn't exist in AMS database.

Description:

This API allows us to remove one SU at a time from the SU rank list of a SI. By removing a SU from SU rank list of a SI, we are destroying the association relation that the SU suName is associated with the SI siName for the purposes of carrying out high availability functions like work assignment etc.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBSetSISURankList()

ClRcT clAmsMgmtCCBDeleteSUCompList	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	suName,
		CL_IN ClAmsEntityT *	compName
	)

Removes a component from the component list of an AMS SU.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
suName	(in) Name of the SU whose component list is being modified.
compName	(in) Name of component that is being removed from the component list of the SU.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The SU specified by the suName doesn't exist in AMS database.

Description:

This API allows us to remove one component at a time from the component list of a SU. By adding an component to component list of a SU, we are destroying a containment relation that the component compName is contained in the SU suName for the purposes of carrying out high availability functions like fault escalation etc.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBSetSUCompList()

ClRcT clAmsMgmtCCBEntityCreate	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN const ClAmsEntityT *	entity
	)

Creates a new instance of an AMS entity.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
entity	(in) The name and type of the new AMS entity to be created.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.

Description:

This API allows us to add new entity into an AMS database dynamically. The newly added entity can be either SG, SI, CSI, Node, SU or Component, depending on the type specified in ClAmsEntityT.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBEntityDelete()

ClRcT clAmsMgmtCCBEntityDelete	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN const ClAmsEntityT *	entity
	)

Deletes an instance of an AMS entity from AMS database.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
entity	(in) The name and type of the new AMS entity to be deleted.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.

Description:

This API allows to delete an AMS entity from the AMS database dynamically. The entity to be removed can be either SG, SI, CSI, Node, SU or Component.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBEntityCreate()

ClRcT clAmsMgmtCCBEntitySetConfig	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityConfigT *	entityConfig,
		CL_IN ClUint64T	bitMask
	)

Sets one or more scalar attributes of an AMS entity.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
entityConfig	(in) New configuration values for the AMS entity attributes(s) whose configuration is being set. AMS entity name and type is also specified in this structure.
bitmask	(in) Mask specifying the attribute(s) whose value is being set to new values.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.

Description:

This API allows us to set one or more of the single valued attribute(s) of an AMS entity. Two set more than one attribute, the bitMasks representing those attributes can be bitwise ORed. The entity can be a SG, SI, CSI, Node, SU or Component. Following paragraphs show what attributes of a particular entity can be set.

SG:

• SG_CONFIG_ADMIN_STATE

SI:

• SI_CONFIG_NUM_STANDBY_ASSIGNMENTS

Component:

• COMP_CONFIG_TIMEOUTS
• COMP_CONFIG_CAPABILITY_MODEL
• COMP_CONFIG_RECOVERY_ON_TIMEOUT
• COMP_CONFIG_INSTANTIATE_COMMAND

Library File:

ClAmsMgmt

See Also

None

ClRcT clAmsMgmtCCBFinalize

(

CL_IN ClAmsMgmtCCBHandleT

ccbHandle

)

Finalizes the AMS management control library.

Header File:

clAmsMgmtClientApi.h

Parameters

ccbHandle

(in) The CCB handle returned by the AMS on invocation of clAmsMgmtCCBInitialize() API.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.

Description:

The clAmsMgmtCCBFinalize() calls removes the applications association with the AMS management control library, and aborts any pending operations. After this call the application should no longer use this handle to call any AMS management control functions.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBCommit(), clAmsMgmtCCBInitialize()

ClRcT clAmsMgmtCCBInitialize	(	CL_IN ClAmsMgmtHandleT	amlHandle,
		CL_OUT ClAmsMgmtCCBHandleT *	ccbHandle
	)

Initializes the AMS management control library.

Header File:

clAmsMgmtClientApi.h

Parameters

amlHandle	(in) The AMS handle returned by the AMS on invocation of the clAmsMgmtInitialize() API.
ccbHandle	(out) The AMS management control handle returned by the library.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	The AMS management handle passed is invalid.

Description:

The clAmsMgmtCCBInitialize() establishes the applications association with the AMS management control library. Application must call this function before using any of the clAmsMgmtCCB* APIs. The CCB functions are transactional. Application then call a number of functions to modify the AMF state, and when complete call clAmsMgmtCCBCommit() to commit the changes to the AMF database. The application can then reuse the handle for another group of state modifications.

However, if the application decides to abort the changes, it must call clAmsMgmtCCBFinalize(), and then clAmsMgmtCCBInitialize() to get a new handle.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBCommit(), clAmsMgmtCCBFinalize()

ClRcT clAmsMgmtCCBSetCSIDependency	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	csiName,
		CL_IN ClAmsEntityT *	dependencyCSIName
	)

Adds a CSI in the CSI dependencies list for an AMS CSI.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
csiName	(in) Name of the CSI whose dependency list is being modified.
dependencyCSIName	(in) Name of the dependent csi to be added in the CSI's dependencies list.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The csi specified by the csiName doesn't exist in AMS database.

Description:

This API allows adding one CSI at a time to the dependency list of a particular CSI. CSI dependency plays roles during CSI assignment, CSI removal etc and generally means that the dependent CSI must be operated upon before operating on the CSI that depends on it.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBDeleteCSIDependency()

ClRcT clAmsMgmtCCBSetNodeDependency	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	nodeName,
		CL_IN ClAmsEntityT *	dependencyNodeName
	)

Adds a node to the node dependencies list of an AMS node.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
nodeName	(in) Name of the node whose dependency list is being modified.
dependencyNodeName	(in) Name of the dependent node to be added in the node's dependencies list.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The node specified by the nodeName doesn't exist in AMS database.

Description:

This API allows adding one node at a time to the dependency list of a particular node. Node dependency plays roles during CSI assignment, CSI removal etc and generally means that the dependent node cannot function properly without the node upon which it depends.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBDeleteNodeDependency()

ClRcT clAmsMgmtCCBSetNodeSUList	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	nodeName,
		CL_IN ClAmsEntityT *	suName
	)

Adds a SU to the SU list of an AMS node.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
nodeName	(in) Name of the node whose SU list is being modified.
suName	(in) Name of SU being added to the SU list of the node.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The node specified by the nodeName doesn't exist in AMS database.

Description:

This API allows us to add one SU at a time to the SU list of a node. By adding an SU to SU list of a node, we are establishing a containment relation that the SU represented by suName is contained in the node nodeName.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBDeleteNodeSUList()

ClRcT clAmsMgmtCCBSetSGSIList	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	sgName,
		CL_IN ClAmsEntityT *	siName
	)

Adds a SI to the SI list of an AMS SG.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
sgName	(in) Name of the SG whose SU list is being modified.
siName	(in) Name of SI being added to the SI list of the SG.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The SG specified by the sgName doesn't exist in AMS database.

Description:

This API allows us to add one SI at a time to the SI list of a SG. By adding an SI to SI list of a SG, we are establishing a containment relation that the SI represented by siName is contained (protected by) in the SG sgName for the purposes of carrying out high availability functions.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBDeleteSGSIList()

ClRcT clAmsMgmtCCBSetSGSUList	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	sgName,
		CL_IN ClAmsEntityT *	suName
	)

Adds a SU to the SU list of an AMS SG.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
sgName	(in) Name of the SG whose SU list is being modified.
suName	(in) Name of SU being added to the SU list of the SG.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The SG specified by the sgName doesn't exist in AMS database.

Description:

This API allows us to add one SU at a time to the SU list of a SG. By adding an SU to SU list of a SG, we are establishing a containment relation that the SU represented by suName is contained (protected by) in the SG sgName for the purposes of carrying out high availability functions like switchover/failover etc.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBDeleteSGSUList()

ClRcT clAmsMgmtCCBSetSICSIList	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	siName,
		CL_IN ClAmsEntityT *	csiName
	)

Adds a CSI in the CSI list for an AMS SI.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
siName	(in) Name of the SI whose CSI list is being modified.
csiName	(in) Name of CSI being added to the CSI list of the SI.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The SI specified by the siName doesn't exist in AMS database.

Description:

This API allows us to add one CSI at a time to the CSI list of a SI. By adding a CSI to CSI list of a SI, we are establishing a containment relation that the CSI csiName is contained in the SI siName for the purposes of carrying out high availability functions like fault escalation etc.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBDeleteSICSIList()

ClRcT clAmsMgmtCCBSetSIDependency	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	siName,
		CL_IN ClAmsEntityT *	dependencySIName
	)

Adds a SI in the SI dependencies list for an AMS SI.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
siName	(in) Name of the SI whose dependency list is being modified.
dependencySIName	(in) Name of the dependent si to be added in the SI's dependencies list.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The si specified by the siName doesn't exist in AMS database.

Description:

This API allows adding one SI at a time to the dependency list of a particular SI. SI dependency plays roles during CSI assignment, CSI removal etc and generally means that the dependent SI must be operated upon before operating on the SI that depends on it.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBDeleteSIDependency()

ClRcT clAmsMgmtCCBSetSISURankList	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	siName,
		CL_IN ClAmsEntityT *	suName
	)

Adds a SU in the SU rank list for an AMS SI.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
siName	(in) Name of the SI whose SU rank list is being modified.
suName	(in) Name of SU being added to the SU rank list of the SI.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The SI specified by the siName doesn't exist in AMS database.

Description:

This API allows us to add one SU at a time to the SU rank list of a SI. By adding an SU to SU rank list of a SI, we are establishing a association relation that the SU suName is associated with the SI siName for the purposes of carrying out high availability functions like work assignment etc.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBDeleteSISURankList()

ClRcT clAmsMgmtCCBSetSUCompList	(	CL_IN ClAmsMgmtCCBHandleT	handle,
		CL_IN ClAmsEntityT *	suName,
		CL_IN ClAmsEntityT *	compName
	)

Adds a component to the component list of an AMS SU.

Header File:

clAmsMgmtClientApi.h

Parameters

handle	(in) The CCB handle returned by the AMS on invocation of the clAmsMgmtCCBInitialize() API.
suName	(in) Name of the SU whose component list is being modified.
compName	(in) Name of component being added to the component list of the SU.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	AMS management handle passed is invalid.
CL_ERR_DOESNT_EXIST	The SU specified by the suName doesn't exist in AMS database.

Description:

This API allows us to add one component at a time to the component list of a SU. By adding an component to component list of a SU, we are establishing a containment relation that the component compName is contained in the SU suName for the purposes of carrying out high availability functions like fault escalation etc.

Library File:

ClAmsMgmt

See Also

clAmsMgmtCCBDeleteSUCompList()

ClAmsCompConfigT* clAmsMgmtCompGetConfig	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN const ClCharT *	entName
	)

Returns the configuration information for a component.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entName	Null terminated name of the AMS entity.

Returns

NULL entity does not exist, or a pointer to the entity configuration. You must free (clHeapFree) this pointer.

Description:

This is a convenience function that returns the current configuration of the entity by calling clAmsMgmtEntityGetConfig with the correct ClAmsEntityT structure.

See Also

clAmsMgmtEntityGetConfig()

Library File:

ClAmsMgmt

ClAmsCompStatusT* clAmsMgmtCompGetStatus	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN const ClCharT *	entName
	)

Returns the current status information of a component.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entName	NULL terminated name of the AMS entity.

Returns

A pointer to the entity's status object, or NULL. You must free (clHeapFree()) this pointer.

Description:

This is a convenience function that returns the current status of the entity by calling clAmsMgmtEntityGetStatus() with the correct ClAmsEntityT structure.

See Also

clAmsMgmtEntityGetConfig()

Library File:

ClAmsMgmt

ClAmsCSIConfigT* clAmsMgmtCompServiceInstanceGetConfig	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN const ClCharT *	entName
	)

Returns the configuration information for a component service instance.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entName	Null terminated name of the AMS entity.

Returns

NULL entity does not exist, or a pointer to the entity configuration. You must free (clHeapFree) this pointer.

Description:

This is a convenience function that returns the current configuration of the entity by calling clAmsMgmtEntityGetConfig with the correct ClAmsEntityT structure.

See Also

clAmsMgmtEntityGetConfig()

Library File:

ClAmsMgmt

ClAmsCSIStatusT* clAmsMgmtCompServiceInstanceGetStatus	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN const ClCharT *	entName
	)

Returns the current status information of a component service instance.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entName	NULL terminated name of the AMS entity.

Returns

A pointer to the entity's status object, or NULL. You must free (clHeapFree()) this pointer.

Description:

This is a convenience function that returns the current status of the entity by calling clAmsMgmtEntityGetStatus() with the correct ClAmsEntityT structure.

See Also

clAmsMgmtEntityGetConfig()

Library File:

ClAmsMgmt

ClRcT clAmsMgmtDebugDisable	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN const ClAmsEntityT *	entity,
		CL_IN ClUint8T	debugFlags
	)

Disables debugging for AMS entitity(ies).

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	(in) Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
entity	(in) Name and type of the entity on which the debugFlags have to be set. NULL value for the entity indicates that debugFlags are being set for entire AMS.
debugFlags	(in) This parameter defines the type of the debug messages to be disabled for entity(ies). See the AMS Debug Flags above for description of various debugFlags. AMS debug flags can be used in conjunction with each other. For example, to disble all types of logging messages, the debugFlags combination will be : CL_AMS_MGMT_SUB_AREA_MSG | CL_AMS_MGMT_SUB_AREA_STATE_CHANGE | CL_AMS_MGMT_SUB_AREA_FN_CALL | CL_AMS_MGMT_SUB_AREA_TIMER

Return values

CL_OK	The function completed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occurred before the call could be completed. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and cannot provide the service.
CL_ERR_NOT_EXIST	Entity on which the administrative action is requested is not found in the AMS database.

Description:

This API disables AMS logging for AMS entity(ies). AMS server logs different types of messages. These messages have been divided in 4 categories i.e. Important ams events related messages, timer related messages, entity state change messages and function entry messages (see details above). This API can be used to disable logging of particular types of messages by AMS server. If the entity name is NULL, AMS server disables debugFlags for all AMS entities.

Library File:

libClAmsMgmt

See Also

clAmsMgmtDebugEnable(), clAmsMgmtDebugGet()

ClRcT clAmsMgmtDebugDisableLogToConsole

(

CL_IN ClAmsMgmtHandleT

amsHandle

)

Disables display of AMS debugging messages on the console.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle

(in) Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.

Return values

CL_OK	The function completed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occurred before the call could be completed. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and cannot provide the service.

Description:

This API is used to disable the display of AMS messages on the standard output. By default, AMS messages are sent to log server. So AMS messages can still be seen using ASP logging facility.

Library File:

libClAmsMgmt

See Also

clAmsMgmtDebugEnableLogToConsole()

ClRcT clAmsMgmtDebugEnable	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN const ClAmsEntityT *	entity,
		CL_IN ClUint8T	debugFlags
	)

Enables debugging for AMS entitity(ies).

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	(in) Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
entity	(in) Name and type of the entity on which the debugFlags have to be set. NULL value for the entity indicates that debugFlags are being set for entire AMS.
debugFlags	(in) This parameter defines the type of the debug messages to be enabled for entity(ies). See the AMS Debug Flags above for description of various debugFlags. AMS debug flags can be used in conjunction with each other. For example, to enable all types of logging messages, the debugFlags combination will be : CL_AMS_MGMT_SUB_AREA_MSG | CL_AMS_MGMT_SUB_AREA_STATE_CHANGE | CL_AMS_MGMT_SUB_AREA_FN_CALL | CL_AMS_MGMT_SUB_AREA_TIMER

Return values

CL_OK	The function completed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occurred before the call could be completed. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and cannot provide the service.
CL_ERR_NOT_EXIST	Entity on which the action is requested is not found in the AMS database.

Description:

This API enables AMS logging for AMS entity(ies). AMS server logs different types of messages. These messages have been divided in 4 categories i.e. Important ams events related messages, timer related messages, entity state change messages and function entry messages (see details above). This API can be used to enable logging of particular types of messages by AMS server.

If the entity name is NULL, AMS server enables debugFlags for all AMS entities.

Library File:

libClAmsMgmt

See Also

clAmsMgmtDebugDisable(), clAmsMgmtDebugGet()

ClRcT clAmsMgmtDebugEnableLogToConsole

(

CL_IN ClAmsMgmtHandleT

amsHandle

)

Enables AMS debugging messages to be displayed on the console.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle

(in) Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.

Return values

CL_OK	The function completed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occurred before the call could be completed. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and cannot provide the service.

Description:

This API is used to display AMS messages on the standard output. By default, AMS messages are sent to log server. This API enables the log messages to be also seen on the screen. This is a useful API to debug and understand AMS server behavior.

Library File:

libClAmsMgmt

See Also

clAmsMgmtDebugDisableLogToConsole()

ClRcT clAmsMgmtDebugGet	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN const ClAmsEntityT *	entity,
		CL_OUT ClUint8T *	debugFlags
	)

Returns the debugging flags for AMS entitity(ies).

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	(in) Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
entity	(in) Name and type of the entity on which the debugFlags have to be set. NULL value for the entity indicates that debugFlags are being set for entire AMS.
debugFlags	(out) AML returns the enabled debugFlags for the AMS entity(ies) in this parameter. See the AMS Debug Flags above for description of various debugFlags.

Return values

CL_OK	The function completed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occurred before the call could be completed. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and cannot provide the service.
CL_ERR_NOT_EXIST	Entity on which the administrative action is requested is not found in the AMS database.

Description:

This API retrieves the debug flags for AMS entity(ies). AMS server logs different types of messages. These messages have been divided in 4 categories i.e. Important ams events related messages, timer related messages, entity state change messages and function entry messages (see details above). This API can be used to retrieve the types of messages, which are currently logged by AMS server.

If the entity name is NULL, AMS server returns debugFlags for all AMS entities.

Library File:

libClAmsMgmt

See Also

clAmsMgmtDebugEnable(), clAmsMgmtDebugDisable()

ClRcT clAmsMgmtEntityGet	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_INOUT ClAmsEntityRefT *	entityRef
	)

Returns the configuration and status scalar attributes of an AMS entity.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
entityRef	Name of the AMS entity whose configuration and status attributes are queried. The attributes are also returned in this structure.

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid

Library File:

ClAmsMgmt

ClRcT clAmsMgmtEntityGetConfig	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	entity,
		CL_OUT ClAmsEntityConfigT **	entityConfig
	)

Returns the configuration scalar attributes of an AMF entity.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
entity	Name of the AMS entity whose configuration attributes are queried
entityConfig	Entity configuration structure returned by AMF

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtEntityGetStatus	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	entity,
		CL_OUT ClAmsEntityStatusT **	entityStatus
	)

returns the status (transient) scalar attributes of an AMS entity

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entity	Name of the AMS entity whose status attributes are queried
entityStatus	Entity status structure returned by AMF. It is your responsibility to clHeapFree() the returned object.

Returns

Return values

CL_OK	- Operation successful
CL_ERR_INVALID_HANDLE	- Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtEntityLockAssignment	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN const ClAmsEntityT *	entity
	)

Changes the administrative state of an AMS entity to lock assigned state.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
entity	Name and type of the entity on which the administrative action is being performed

Return values

CL_OK	The function executed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMmgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occured before the call could complete. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_TRY_AGAIN	The service can not be provided at this time. The process may try later. This error is generally returned in cases where the requested action is valid but not currently possible, probably because another operation is acting upon the logical entity on which the administrative operation is invoked. Such an operation can be another administrative operation or an error recovery initiated by the AMF.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and can not provide the service.
CL_ERR_NO_OP	Invocation of this administrative operation has no effect on the current state of the logical entity as it is already in lock assigned state
CL_ERR_BAD_OPERATION	Administrative action is not a valid operation for the logical entity in the current administrative state.
CL_ERR_NOT_EXIST	Entity on which the administrative action is requested is not found in the AMS database.

Description:

The administrative operation is applicable to all Availability Management Framework entities that possess an administrative state, namely, service unit, service instance, node, and service group. The invocation of this administrative operation sets the administrative state of the logical entity designated by entity to locked assignment.

If this operation is invoked by a client on an entity that is already locked assigned, there is no change in the status of such an entity i.e. it remains in the locked assigned state, but a benign error value CL_ERR_NO_OP is returned to the client conveying that the entity in question, designated by entity, is already in the locked assigned state.

If this operation is invoked on an entity that is locked for instantiation, there is no change in the status of such an entity, i.e. it remains in the locked instantiation state, and the caller is returned a CL_ERR_BAD_OPERATION error value.

Library File:

libClAmsMgmt

See Also

clAmsMgmtEntityLockInstantiation(), clAmsMgmtEntityUnlock()

ClRcT clAmsMgmtEntityLockInstantiation	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN const ClAmsEntityT *	entity
	)

Changes the administrative state of an AMS entity to lock instantiated state.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
entity	Name and type of the entity on which the administrative action is being performed

Return values

CL_OK	The function executed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMmgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occured before the call could complete. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_TRY_AGAIN	The service can not be provided at this time. The process may try later. This error is generally returned in cases where the requested action is valid but not currently possible, probably because another operation is acting upon the logical entity on which the administrative operation is invoked. Such an operation can be another administrative operation or an error recovery initiated by the AMF.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and can not provide the service.
CL_ERR_NO_OP	Invocation of this administrative operation has no effect on the current state of the logical entity as it is already in lock instantiated state.
CL_ERR_BAD_OPERATION	Administrative action is not a valid operation for the logical entity in the current administrative state.
CL_ERR_NOT_EXIST	Entity on which the administrative action is requested is not found in the AMS database.

Description:

The administrative operation is applicable to Availability Management Framework entities service unit, node and service group. The invocation of this administrative operation sets the administrative state of the logical entity designated by entity to locked instantiation.

After successful invocation of this procedure, all components in all pertinent service units are terminated. In particular, all processes in those components must cease to exist.

Once this operation is invoked on a logical entity, as explained above, all pertinent service units within its scope become non-instantiable ( after being terminated ) and the effect of this operation can be reversed by applying another administrative operation clAmsMgmtEntityLockAssignment, which cause the relevent service units to be instantiated in a locked assigned state provided that the entity is not locked for instantiation at any other level.

If this operation is invoked by a client on an entity that is already locked instantiated, there is no change in the status of such an entity i.e. it remains in the locked instantiated state, but a benign error value CL_ERR_NO_OP is returned to the client conveying that the entity in question , designated by entity, is already in the locked instantiated state.

If this operation is invoked on an entity that is either in the shutting-down or unlocked administrative state, there is no change in the status of such an entity, i.e. it remains in the respective state, and the caller is returned a CL_ERR_BAD_OPERATION error value.

Library File:

libClAmsMgmt

See Also

clAmsMgmtEntityLockAssignment(), clAmsMgmtEntityUnlock()

ClRcT clAmsMgmtEntityRepaired	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN const ClAmsEntityT *	entity
	)

Marks a previously faulty entity as repaired, so that AMS can use it again for work assignment.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
entity	Name and type of the entity on which the administrative action is being performed

Return values

CL_OK	The function executed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMmgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occured before the call could complete. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_TRY_AGAIN	The service can not be provided at this time. The process may try later. This error is generally returned in cases where the requested action is valid but not currently possible, probably because another operation is acting upon the logical entity on which the administrative operation is invoked. Such an operation can be another administrative operation or an error recovery initiated by the AMF.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and can not provide the service.
CL_ERR_NO_OP	Invocation of this administrative operation has no effect on the current state of the logical entity as it is already enabled.
CL_ERR_BAD_OPERATION	The operation could not insure that the presence states of the relevent service units and components are either instantiated or uninstantiated.
CL_ERR_NOT_EXIST	Entity on which the administrative action is requested is not found in the AMS database.
CL_AMS_ERR_INVALID_ENTITY	Administrative operation is not valid for the entity type designated by type field in entity.

Description:

The administrative operation is applicable for a service unit or a node.

This administrative operation is used to clear the disabled operational state of a node or a service unit after they have been successfully mended to declare them as repaired. The administrator uses this operation to indicate the availability of a service unit or a node for providing service after an externally executed repair action. When invoked on a node this operation results enabling the operational state of the constituent service units and components. When invoked on a service unit, it has a similar effect on all the components that make up the service unit.

AMS might optionally engage in repairing a node or a service unit after a successful recovery procedure execution in which case the AMS itself will clear the disabled state of the involved node or a service unit, but if a repair action is undertaken by an external entity outside the scope of the AMS, or the AMS failed to successfully repair ( and the repair requires intervention by an external entity ), one should use this administrative operation to clear the disabled state of the node or the service unit to indicate that these entities are repaired and their operational state is enabled.

If this administrative operation is invoked on a logical entity that is already enabled, the entity remains in that state, and a benign error value of CL_ERR_NO_OP is returned to the caller.

Library File:

libClAmsMgmt

See Also

clAmsMgmtEntityLockAssignment(), clAmsMgmtEntityLockInstantiation(), clAmsMgmtEntityUnlock(), clAmsMgmtEntityShutdown(), clAmsMgmtEntityRestart()

Marks a previously faulty entity as repaired, so that AMS can use it again for work assignment.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
entity	Name and type of the entity on which the administrative action is being performed

Return values

CL_OK	The function executed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMmgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occured before the call could complete. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_TRY_AGAIN	The service can not be provided at this time. The process may try later. This error is generally returned in cases where the requested action is valid but not currently possible, probably because another operation is acting upon the logical entity on which the administrative operation is invoked. Such an operation can be another administrative operation or an error recovery initiated by the AMF.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and can not provide the service.
CL_ERR_NO_OP	Invocation of this administrative operation has no effect on the current state of the logical entity as it is already enabled.
CL_ERR_BAD_OPERATION	The operation could not insure that the presence states of the relevent service units and components are either instantiated or uninstantiated.
CL_ERR_NOT_EXIST	Entity on which the administrative action is requested is not found in the AMS database.
CL_AMS_ERR_INVALID_ENTITY	Administrative operation is not valid for the entity type designated by type field in entity.

Description:

The administrative operation is applicable for a service unit or a node.

This administrative operation is used to clear the disabled operational state of a node or a service unit after they have been successfully mended to declare them as repaired. The administrator uses this operation to indicate the availability of a service unit or a node for providing service after an externally executed repair action. When invoked on a node this operation results enabling the operational state of the constituent service units and components. When invoked on a service unit, it has a similar effect on all the components that make up the service unit.

AMS might optionally engage in repairing a node or a service unit after a successful recovery procedure execution in which case the AMS itself will clear the disabled state of the involved node or a service unit, but if a repair action is undertaken by an external entity outside the scope of the AMS, or the AMS failed to successfully repair ( and the repair requires intervention by an external entity ), one should use this administrative operation to clear the disabled state of the node or the service unit to indicate that these entities are repaired and their operational state is enabled.

If this administrative operation is invoked on a logical entity that is already enabled, the entity remains in that state, and a benign error value of CL_ERR_NO_OP is returned to the caller.

Library File:

libClAmsMgmt

See Also

clAmsMgmtEntityLockAssignment(), clAmsMgmtEntityLockInstantiation(), clAmsMgmtEntityUnlock(), clAmsMgmtEntityShutdown(), clAmsMgmtEntityRestart()

ClRcT clAmsMgmtEntityRestart	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN const ClAmsEntityT *	entity
	)

Restart an AMS entity following termination .

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
entity	Name and type of the entity on which the administrative action is being performed

Return values

CL_OK	The function executed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMmgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occured before the call could complete. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_TRY_AGAIN	The service can not be provided at this time. The process may try later. This error is generally returned in cases where the requested action is valid but not currently possible, probably because another operation is acting upon the logical entity on which the administrative operation is invoked. Such an operation can be another administrative operation or an error recovery initiated by the AMF.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and can not provide the service.
CL_ERR_NO_OP	Invocation of this administrative operation has no effect on the current state of the logical entity as it is currently restarting.
CL_ERR_BAD_OPERATION	The logical entity could not be restarted for various reasons like the presence state of the service unit or the component to be re-started was not instantiated.
CL_ERR_NOT_EXIST	Entity on which the administrative action is requested is not found in the AMS database.
CL_AMS_ERR_INVALID_ENTITY	Administrative operation is not valid for the entity type designated by type field in entity.

Description:

The administrative operation is applicable for component, service unit or node. This procedure typically involves a termination action followed by a subsequent instantiation of either the concerned entity or logical entities that belong to the concerned entity.

This administrative operation is applicable to only those service units whose presence state is instantiated. The invocation of this administrative operation on a service unit causes the service unit to be restarted by restarting all the components within it.

If this operation is invoked by a client on an entity that is not restartable, there is no change in the status of such an entity, but the caller is returned a benign CL_ERR_NO_OP error value, which means that no action is being performed.

When this operation is performed on an individual component, only the component implied in the operation is restarted.

When this operation is invoked upon a service unit this operation becomes a composite operation that cause collective restart of all components within the service unit. In-order to execute such a collective restart of all the components in a particular scope, the AMF first completely terminates all pertinent components and does not start instantiating them back until all components have been terminated.

When invoked upon a node, this operation becomes a composite operation that causes a collective restart of all service units residing within the node. In-order to execute such a collective restart of all the service units in a particular scope, the AMF first completely terminates all pertinent service units and does not start instantiating them back until all service units have been terminated.

AMF does not proceed with this operation if another administrative operation or an error recovery initiated by AMF is already engaged on the logical entity. In such case, an error value of CL_ERR_TRY_AGAIN is returned indicating that the action is feasible but not at this instant.

Library File:

libClAmsMgmt

See Also

clAmsMgmtEntityLockAssignment(), clAmsMgmtEntityLockInstantiation(), clAmsMgmtEntityUnlock(), clAmsMgmtEntityShutdown()

ClRcT clAmsMgmtEntitySetAlphaFactor	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN ClAmsEntityT *	entity,
		CL_IN ClUint32T	alphaFactor
	)

Changes the alpha factor configured for a given SG.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	(in) Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
entity	(in) Name of the SG and type should be CL_AMS_ENTITY_TYPE_SG to get current alpha factor configured for the SG
alphaFactor	(in) The value for the alphaFactor which should be between 0 and 100.

Return values

CL_OK	The function completed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occurred before the call could be completed. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and cannot provide the service.
CL_ERR_INVALID_PARAMETER	The alpha factor provided was invalid.
CL_ERR_NOT_EXIST	The SG wasnt found in the AMS DB to change the alpha factor

Description:

This API is used to change the SGs alpha factor configuration. This variable limits the active number of service units incase the available service units are less than the preferred active service units. This variable helps to dynamically limit the active service units that can be assigned work. Judicious usage of this variable would allow dynamic changes to redundancy mode at runtime without disrupting service. For example with a 10+1 model, one can start with an alpha factor of 10 to get 1+1 incase nodes are going to be added dynamically or incase the active service units are supposed to be restricted. Making it 20, would give 2+1. So one can add the third blade and then change alpha factor to 20. By default, the alpha factor is set to 100 which takes into account, all the available service units. The acceptable values for alpha factor are between 0 and 100. Providing a value of 0 would result in assigning 1 active service unit incase the available service units are less than preferred and SG has instantiable service units.

Library File:

libClAmsMgmt

See Also

clAmsMgmtEntityGetConfig

ClRcT clAmsMgmtEntitySetBetaFactor	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN ClAmsEntityT *	entity,
		CL_IN ClUint32T	betaFactor
	)

Changes the beta factor configured for a given SG.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	(in) Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
entity	(in) Name of the SG and type should be CL_AMS_ENTITY_TYPE_SG to get current alpha factor configured for the SG
betaFactor	(in) The value for the betaFactor which should be between 0 and 100.

Return values

CL_OK	The function completed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occurred before the call could be completed. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and cannot provide the service.
CL_ERR_INVALID_PARAMETER	The beta factor provided was invalid.
CL_ERR_NOT_EXIST	The SG wasnt found in the AMS DB to change the beta factor

Description:

This API is used to change the SGs beta factor configuration. This variable limits the standby number of service units incase the available service units are less than the preferred standby service units. This variable helps to dynamically limit the standby service units that can be assigned work. Judicious usage of this variable would allow dynamic changes to redundancy mode at runtime without disrupting service. For example with a 10+1 model, one can start with an beta factor of 100 to get 1+1 incase nodes are going to be added dynamically or incase the active service units are supposed to be restricted. As nodes enter the cluster, it would increase slowly from 2+1 to 3+1,4+1,... 10+1. By default the value is set to 0 or disabled. The acceptable values for beta factor are between 0 and 100.

Library File:

libClAmsMgmt

See Also

clAmsMgmtEntityGetConfig

ClRcT clAmsMgmtEntityShutdown	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN const ClAmsEntityT *	entity
	)

Changes the administrative state of an AMS entity to shutting-down.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
entity	Name and type of the entity on which the administrative action is being performed

Return values

CL_OK	The function executed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMmgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occured before the call could complete. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_TRY_AGAIN	The service can not be provided at this time. The process may try later. This error is generally returned in cases where the requested action is valid but not currently possible, probably because another operation is acting upon the logical entity on which the administrative operation is invoked. Such an operation can be another administrative operation or an error recovery initiated by the AMF.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and can not provide the service.
CL_ERR_NO_OP	Invocation of this administrative operation has no effect on the current state of the logical entity as it is already in shutting-down state.
CL_ERR_BAD_OPERATION	Administrative action is not a valid operation for the logical entity in the current administrative state.
CL_ERR_NOT_EXIST	Entity on which the administrative action is requested is not found in the AMS database.

Description:

The administrative operation is applicable to all Availability Management Framework entities that possess an administrative state, namely, service unit, service instance, node, and service group. The invocation of this administrative operation sets the administrative state of the logical entity designated by entity to shutting-down. The administrative operation is non-blocking i.e. It does not wait for the logical entity designated by entity to transition to the locked instantiation state, which can possibly take a very long time.

If this operation is invoked by a client on an entity that is already in shutting-down administrative state, there is no change in the status of such an entity i.e. it continues shutting-down and the caller is returned a benign CL_ERR_NO_OP error value, which means that entity is already shutting-down.

If this operation is invoked on an entity that is in either in locked instantiation or lock assignment administrative state, there is no change in the status of such an entity, i.e. it remains in the respective state, and the caller is returned a CL_ERR_BAD_OPERATION error value.

Library File:

libClAmsMgmt

See Also

clAmsMgmtEntityLockAssignment(), clAmsMgmtEntityLockInstantiation(), clAmsMgmtEntityUnlock()

ClRcT clAmsMgmtEntityUnlock	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN const ClAmsEntityT *	entity
	)

Changes the administrative state of an AMS entity to unlocked state.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
entity	Name and type of the entity on which the administrative action is being performed

Return values

CL_OK	The function executed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMmgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occured before the call could complete. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_TRY_AGAIN	The service can not be provided at this time. The process may try later. This error is generally returned in cases where the requested action is valid but not currently possible, probably because another operation is acting upon the logical entity on which the administrative operation is invoked. Such an operation can be another administrative operation or an error recovery initiated by the AMF.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and can not provide the service.
CL_ERR_NO_OP	Invocation of this administrative operation has no effect on the current state of the logical entity as it is already in lock instantiated state.
CL_ERR_BAD_OPERATION	Administrative action is not a valid operation for the logical entity in the current administrative state.
CL_ERR_NOT_EXIST	Entity on which the administrative action is requested is not found in the AMS database.

Description:

The administrative operation is applicable to all Availability Management Framework entities that possess an administrative state, namely, service unit, service instance, node, and service group. The invocation of this administrative operation sets the administrative state of the logical entity designated by entity to unlocked. If this operation is invoked by a client on an entity that is already unlocked, there is no change in the status of such an entity i.e. it remains in the unlocked state, but a benign error value CL_ERR_NO_OP is returned to the client conveying that the entity in question, designated by entity, is already in the unlocked state. If this operation is invoked on an entity that is locked for instantiation, there is no change in the status of such an entity, i.e. it remains in the respective state, and the caller is returned a CL_ERR_BAD_OPERATION error value.

Library File:

libClAmsMgmt

See Also

clAmsMgmtEntityLockAssignment(), clAmsMgmtEntityLockInstantiation()

ClRcT clAmsMgmtEntityUserDataDelete	(	ClAmsMgmtHandleT	handle,
		ClAmsEntityT *	entity
	)

Deletes the data for the default key associated with an AMF entity.

Parameters

handle	(in) The AMS handle returned from clAmsMgmtInitialize() API.
entity	(in) Name and type of the relevant entity

Return values

CL_OK	The API executed successfully.
CL_CID_AMS:CL_ERR_NOT_EXIST	The entity does not exist

Description:

This API deletes the arbitrary chunk of data for the default key associated with this entity. This data can be used by application code for any purpose.

See Also

clAmsMgmtEntityUserDataDeleteKey(), clAmsMgmtEntityUserDataSet(), clAmsMgmtEntityUserDataGetKey()

ClRcT clAmsMgmtEntityUserDataDeleteAll	(	ClAmsMgmtHandleT	handle,
		ClAmsEntityT *	entity
	)

Deletes all the data associated with an AMF entity for all keys.

Parameters

handle	(in) The AMS handle returned from clAmsMgmtInitialize() API.
entity	(in) Name and type of the relevant entity

Return values

CL_OK	The API executed successfully.
CL_CID_AMS:CL_ERR_NOT_EXIST	The entity does not exist

Description:

This API deletes the arbitrary chunk of data for all the keys associated with this entity. This data can be used by application code for any purpose.

See Also

clAmsMgmtEntityUserDataDeleteKey(), clAmsMgmtEntityUserDataSet(), clAmsMgmtEntityUserDataGetKey()

ClRcT clAmsMgmtEntityUserDataDeleteKey	(	ClAmsMgmtHandleT	handle,
		ClAmsEntityT *	entity,
		ClNameT *	key
	)

Deletes the arbitrary data associated with an AMF entity and a key.

Parameters

handle	(in) The AMS handle returned from clAmsMgmtInitialize() API.
entity	(in) Name and type of the relevant entity
data	(out) pointer to buffer of data. I will malloc. Free using clHeapFree)
len	(out) Length (bytes) of the data in the buffer

Return values

CL_OK	The API executed successfully.
CL_CID_CNT:CL_ERR_NOT_EXIST	The key does not exist
CL_CID_AMS:CL_ERR_NOT_EXIST	The entity does not exist

Description:

This API deletes the arbitrary chunk of data associated with this entity. This data can be used by application code for any purpose. This API allows key-specific data to be deleted. This is not meant to be a database! A fixed and small # of key slots are available (can be sized by changing a constant and recompilation).

See Also

clAmsMgmtEntityUserDataSetKey(), clAmsMgmtEntityUserDataGetKey()

ClRcT clAmsMgmtEntityUserDataGet	(	ClAmsMgmtHandleT	handle,
		ClAmsEntityT *	entity,
		ClCharT **	data,
		ClUint32T *	len
	)

Retrieve arbitrary data associated with an AMF entity.

Parameters

handle	(in) The AMS handle returned from clAmsMgmtInitialize() API.
entity	(in) Name and type of the relevant entity
data	(out) pointer to buffer of data. I will malloc. Free using clHeapFree)
len	(out) Length (bytes) of the data in the buffer

Return values

CL_OK	The API executed successfully.
CL_CID_CNT:CL_ERR_NOT_EXIST	The key does not exist
CL_CID_AMS:CL_ERR_NOT_EXIST	The entity does not exist

Description:

This API retrieves the arbitrary chunk of data associated with this entity. This data can be used by application code for any purpose.

See Also

clAmsMgmtEntityUserDataDelete(), clAmsMgmtEntityUserDataSet(), clAmsMgmtEntityUserDataGetKey()

ClRcT clAmsMgmtEntityUserDataGetKey	(	ClAmsMgmtHandleT	handle,
		ClAmsEntityT *	entity,
		ClNameT *	key,
		ClCharT **	data,
		ClUint32T *	len
	)

Retrieve arbitrary data associated with an AMF entity and a key.

Parameters

handle	(in) The AMS handle returned from clAmsMgmtInitialize() API.
entity	(in) Name and type of the relevant entity
data	(out) pointer to buffer of data. I will malloc. Free using clHeapFree)
len	(out) Length (bytes) of the data in the buffer

Return values

CL_OK	The API executed successfully.
CL_CID_CNT:CL_ERR_NOT_EXIST	The key does not exist
CL_CID_AMS:CL_ERR_NOT_EXIST	The entity does not exist

Description:

This API retrieves the arbitrary chunk of data associated with this entity. This data can be used by application code for any purpose. This API allows multiple applications to store independent data through the use of a key. This is not meant to be a database! A fixed and small # of key slots are available (can be sized by changing a constant and recompilation).

See Also

clAmsMgmtEntityUserDataDeleteKey(), clAmsMgmtEntityUserDataSet(), clAmsMgmtEntityUserDataGetKey()

ClRcT clAmsMgmtEntityUserDataSet	(	ClAmsMgmtHandleT	handle,
		ClAmsEntityT *	entity,
		ClCharT *	data,
		ClUint32T	len
	)

Associate arbitrary data with an AMF entity.

Parameters

handle	(in) The AMS handle returned from clAmsMgmtInitialize() API.
entity	(in) Name and type of the relevant entity
data	(in) Buffer of data to associate
len	(in) Length (bytes) of the data in the buffer

Return values

CL_OK	The API executed successfully.
CL_CID_AMS:CL_ERR_NOT_EXIST	The entity does not exist

Description:

This API persistently associates an arbitrary chunk of data with this entity. This data can be used by application code for any purpose.

See Also

clAmsMgmtEntityUserDataDelete(), clAmsMgmtEntityUserDataGet(), clAmsMgmtEntityUserDataSetKey()

ClRcT clAmsMgmtEntityUserDataSetKey	(	ClAmsMgmtHandleT	handle,
		ClAmsEntityT *	entity,
		ClNameT *	key,
		ClCharT *	data,
		ClUint32T	len
	)

Associate arbitrary data with an AMF entity and a key.

Parameters

handle	(in) The AMS handle returned from clAmsMgmtInitialize() API.
entity	(in) Name and type of the relevant entity
data	(in) Buffer of data to associate
len	(in) Length (bytes) of the data in the buffer

Return values

CL_OK	The API executed successfully.
CL_CID_CNT:CL_ERR_NOT_EXIST	The key does not exist
CL_CID_AMS:CL_ERR_NOT_EXIST	The entity does not exist

Description:

This API persistently associates an arbitrary chunk of data with this entity. This data can be used by application code for any purpose. This API allows multiple applications to store independent data through the use of a key. This is not meant to be a database! A fixed and small # of key slots are available (can be sized by changing a constant and recompilation).

See Also

clAmsMgmtEntityUserDataDeleteKey(), clAmsMgmtEntityUserDataSet(), clAmsMgmtEntityUserDataGetKey()

ClRcT clAmsMgmtFinalize

(

CL_IN ClAmsMgmtHandleT

amsHandle

)

Terminates the use of the management function library.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle

Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.

Return values

CL_OK	The function executed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMmgmtInitialize API.
CL_ERR_TIMEOUT	Timeout occured before the call could complete. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_TRY_AGAIN	The service can not be provided at this time. The process may retry later.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and can not provide the service.

Description:

This function is used to terminate the use of the management function library.This must be called when the services of the AMS library are no longer required. This function frees all resources allocated during initialization of the library through the clAmsMgmtInitialize() function.

Library File:

ClAmsMgmtClient

See Also

clAmsMgmtInitialize()

ClRcT clAmsMgmtGetCompCSIList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	comp,
		CL_OUT ClAmsCompCSIRefBufferT *	csiBuffer
	)

returns the list of csi's assigned to a component

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
comp	Name of the component whose csi list is queried
csiBuffer	Buffer containing the list of csi's assigned to the component

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetCompList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_OUT ClAmsEntityBufferT *	entityBuffer
	)

Get all component entity names.

Parameters

handle	Handle returned by the AMF on invocation of clAmsMgmtInitialize API.
entityBuffer	Buffer containing an array of entity names

Returns

Clovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid

Description:

This is a type-safe wrapper around clAmsMgmtGetList()

See Also

clAmsMgmtGetList()

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetCSIDependenciesList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	csi,
		CL_OUT ClAmsEntityBufferT *	dependenciesCSIBuffer
	)

returns the csi-csi dependencies list for a csi

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
csi	Name of the csi whose csi-csi dependencies list is queried
dependenciesCSIBuffer	Buffer containing the csi-csi dependencies list for the csi

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetCSIList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_OUT ClAmsEntityBufferT *	entityBuffer
	)

Get all component service instance entity names.

Parameters

handle	Handle returned by the AMF on invocation of clAmsMgmtInitialize API.
entityBuffer	Buffer containing an array of entity names

Returns

Clovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid

Description:

This is a type-safe wrapper around clAmsMgmtGetList()

See Also

clAmsMgmtGetList()

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetCSINVPList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	csi,
		CL_OUT ClAmsCSINVPBufferT *	nvpBuffer
	)

returns the name value pair list for a csi

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
csi	Name of the csi whose nvp list is queried
nvpBuffer	Buffer containing the nvp list for the csi

Returns

Clovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityListTypeT	listName,
		CL_OUT ClAmsEntityBufferT *	buffer
	)

Get all entities of a particular type.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
listName	What type of entity to get.

Returns

Success or error code

Description:

The function gets the names of all entities of a particular type. It can be called for each type to get the names of all entities. These names can then be used to retrieve the configuration and status of every entity, giving access to the complete AMF entity database.

See Also

clAmsMgmtEntityGetConfig(), clAmsMgmtEntityGetStatus()

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetNodeDependenciesList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	node,
		CL_OUT ClAmsEntityBufferT *	dependencyBuffer
	)

returns the node dependencies list for a node

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
node	Name of the node whose node dependencies list is queried
dependencyBuffer	Buffer containing the node dependencies list for the node

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetNodeList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_OUT ClAmsEntityBufferT *	entityBuffer
	)

Get all node entity names.

Parameters

handle	Handle returned by the AMF on invocation of clAmsMgmtInitialize API.
entityBuffer	Buffer containing an array of entity names

Returns

Clovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid

Description:

This is a type-safe wrapper around clAmsMgmtGetList()

See Also

clAmsMgmtGetList()

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetNodeSUList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	node,
		CL_OUT ClAmsEntityBufferT *	suBuffer
	)

returns the node su list for a node

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
node	Name of the node whose su list is queried
suBuffer	Buffer containing the node su list for the node

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSGAssignedSUList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	sg,
		CL_OUT ClAmsEntityBufferT *	assignedSUBuffer
	)

returns the assigned su list for a sg

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
sg	Name of the sg whose assigned su list is queried
assignedSUBuffer	Buffer containing the assigned su list for the sg

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSGFaultySUList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	sg,
		CL_OUT ClAmsEntityBufferT *	faultySUBuffer
	)

returns the faulty su list for a sg

Parameters

\param	handle Handle returned by the AML on invocation of clAmsMgmtInitialize API.
sg	Name of the sg whose faulty su list is queried
faultySUBuffer	Buffer containing the faulty su list for the sg

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSGInServiceSpareSUList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	sg,
		CL_OUT ClAmsEntityBufferT *	inserviceSpareSUBuffer
	)

returns the in service spare su list for a sg

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
sg	Name of the sg whose inservice spare su list is queried
inserviceSpareSUBuffer	Buffer containing the inservice spare su list for the sg

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSGInstantiableSUList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	sg,
		CL_OUT ClAmsEntityBufferT *	instantiableSUBuffer
	)

returns the instantiable su list for a sg

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
sg	Name of the sg whose instantiable su list is queried
instantiableSUBuffer	Buffer containing the instantiable su list for the sg

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSGInstantiatedSUList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	sg,
		CL_OUT ClAmsEntityBufferT *	instantiatedSUBuffer
	)

returns the instantiated su list for a sg

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
sg	Name of the sg whose instantiated su list is queried
instantiatedSUBuffer	Buffer containing the instantiated su list for the sg

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSGList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_OUT ClAmsEntityBufferT *	entityBuffer
	)

Get all service group names.

Parameters

handle	Handle returned by the AMF on invocation of clAmsMgmtInitialize API.
entityBuffer	Buffer containing an array of entity names

Returns

Clovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid

Description:

This is a type-safe wrapper around clAmsMgmtGetList()

See Also

clAmsMgmtGetList()

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSGSIList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	sg,
		CL_OUT ClAmsEntityBufferT *	siBuffer
	)

returns the sg si list for a sg

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
sg	Name of the sg whose si list is queried
siBuffer	Buffer containing the sg si list for the sg

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSGSUList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	sg,
		CL_OUT ClAmsEntityBufferT *	suBuffer
	)

returns the sg su list for a sg

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
sg	Name of the sg whose su list is queried
suBuffer	Buffer containing the sg su list for the sg

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSICSIList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	si,
		CL_OUT ClAmsEntityBufferT *	csiBuffer
	)

returns the si-csi list for a si

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
si	Name of the si whose si-csi list is queried
csiBuffer	Buffer containing the csi list for the si

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSIDependenciesList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	si,
		CL_OUT ClAmsEntityBufferT *	dependenciesSIBuffer
	)

returns the si-si dependencies list for a si

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
si	Name of the si whose si-si dependencies list is queried
dependenciesSIBuffer	Buffer containing the si-si dependencies list for the si

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSIList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_OUT ClAmsEntityBufferT *	entityBuffer
	)

Get all service instance entity names.

Parameters

handle	Handle returned by the AMF on invocation of clAmsMgmtInitialize API.
entityBuffer	Buffer containing an array of entity names

Returns

Clovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid

Description:

This is a type-safe wrapper around clAmsMgmtGetList()

See Also

clAmsMgmtGetList()

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSISUList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	si,
		CL_OUT ClAmsSISURefBufferT *	suBuffer
	)

returns the su list for si

Parameters

\param	handle Handle returned by the AML on invocation of clAmsMgmtInitialize API.
si	Name of the si whose su list is queried
suBuffer	Buffer containing the su list for the si

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSISURankList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	si,
		CL_OUT ClAmsEntityBufferT *	suBuffer
	)

returns the si-su rank list for a si

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
si	Name of the si whose su rank list is queried
suBuffer	Buffer containing the su rank list for the si

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSUAssignedSIsList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	su,
		CL_OUT ClAmsSUSIRefBufferT *	siBuffer
	)

returns the assigned si's list for su

Parameters

\param	handle Handle returned by the AML on invocation of clAmsMgmtInitialize API.
su	Name of the su whose assigned si's list is queried
siBuffer	Buffer containing the si's list for the su

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSUCompList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN ClAmsEntityT *	su,
		CL_OUT ClAmsEntityBufferT *	compBuffer
	)

returns the component list for a su

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize API.
su	Name of the su whose component list is queried
compBuffer	Buffer containing the component list for the su

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_AMS_ERR_INVALID_ENTITY	The entity is not valid
CL_ERR_NOT_EXIST	The entity does not exist

Library File:

ClAmsMgmt

ClRcT clAmsMgmtGetSUList	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_OUT ClAmsEntityBufferT *	entityBuffer
	)

Get all service unit entity names.

Parameters

handle	Handle returned by the AMF on invocation of clAmsMgmtInitialize API.
entityBuffer	Buffer containing an array of entity names

Returns

Clovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid

Description:

This is a type-safe wrapper around clAmsMgmtGetList()

See Also

clAmsMgmtGetList()

Library File:

ClAmsMgmt

ClRcT clAmsMgmtInitialize	(	CL_OUT ClAmsMgmtHandleT *	amsHandle,
		CL_IN const ClAmsMgmtCallbacksT *	amsMgmtCallbacks,
		CL_INOUT ClVersionT *	version
	)

Starts the use of the management function library.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	(out) The handle returned by the function. It identifies a particular initialization of the Availability Management Framework. This handle must be passed as the first input parameter for all further usage of the function library.
amsCallbacks	(in) Callbacks into management function user.
version	(in/out) In the input parameter, you must pass the current version of AMS on the client. In the output parameter, you will receive the supported version.

Return values

CL_OK	The function executed successfully.
CL_ERR_VERSION_MISMATCH	If the current version and the supported version are not the same.
CL_ERR_TIMEOUT	Timeout occured before the call could complete. It is unspecified whether the call succeeded or whether it did not.
CL_ERR_TRY_AGAIN	The service can not be provided at this time. The process may retry later.
CL_ERR_INVALID_PARAMETER	A parameter is not set correctly.
CL_ERR_NO_MEMORY	Either the AMS library or the provider of service is out of memory and so cannot provide the service.
CL_ERR_NULL_POINTER	Pointer to an invalid memory space.

Description:

This function is used to start the use of the management function library. It typically registers callbacks and it must be called before invoking any other function of the AMS library. In this release there are no callbacks to be registered.

Library File:

ClAmsMgmtClient

See Also

clAmsMgmtFinalize()

ClRcT clAmsMgmtMigrateSG	(	ClAmsMgmtHandleT	handle,
		const ClCharT *	sg,
		const ClCharT *	prefix,
		ClUint32T	activeSUs,
		ClUint32T	standbySUs,
		ClAmsMgmtMigrateListT *	migrateList
	)

Convert an SG from one redundancy model to another, without taking it offline.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
sg	Name of the Service Group that is being modified
prefix	Newly created entities' names will start with this string
activeSUs	Number of service units you want to be active.
standbySUs	Number of service units you want to be standby.
migrateList	All entities that were created for you to tweak before committing.

Returns

OpenClovis return code

Return values

CL_OK	Operation successful
CL_ERR_INVALID_HANDLE	Error: AML CCB Handle is invalid
CL_ERR_NOT_EXIST	The entity does not exist

Description:

This function uses all of the other functions defined in this module to implement a major configuration change to an SG. The SG can be either inservice or out-of-service during this call. Inservice entities will be disturbed as little as possible during the configuration modification.

The function does not give you complete control over all aspects of the configuration change, notably it does not let you choose which SUs to remove (if you are reducing the number of SUs), and it does not let you choose which nodes to deploy new SUs onto (if increasing the SUs). For this reason, it may be more appropriate for you to use this function as an example implementation rather than to call it directly.

However, we do attempt to make intelligent decisions about what to remove or add. For example, the function will prefer to remove entities that are not in service (so if you want to remove particular entities, simply shut those and only those entities down before calling this function), and it will preferentially create entities on existing nodes that are not controllers and do not currently contain this SG.

Library File:

ClAmsMgmt

ClAmsNodeConfigT* clAmsMgmtNodeGetConfig	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN const ClCharT *	entName
	)

Returns the configuration information for nodes.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entName	Null terminated name of the AMS entity.

Returns

NULL entity does not exist, or a pointer to the entity configuration. You must free (clHeapFree) this pointer.

Description:

This is a convenience function that returns the current configuration of the entity by calling clAmsMgmtEntityGetConfig with the correct ClAmsEntityT structure.

See Also

clAmsMgmtEntityGetConfig()

Library File:

ClAmsMgmt

ClAmsNodeStatusT* clAmsMgmtNodeGetStatus	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN const ClCharT *	entName
	)

Returns the current status information of a node.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entName	NULL terminated name of the AMS entity.

Returns

A pointer to the entity's status object, or NULL. You must free (clHeapFree()) this pointer.

Description:

This is a convenience function that returns the current status of the entity by calling clAmsMgmtEntityGetStatus() with the correct ClAmsEntityT structure.

See Also

clAmsMgmtEntityGetConfig()

Library File:

ClAmsMgmt

ClAmsSGConfigT* clAmsMgmtServiceGroupGetConfig	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN const ClCharT *	entName
	)

Returns the configuration information for a service group.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entName	Null terminated name of the AMS entity.

Returns

NULL entity does not exist, or a pointer to the entity configuration. You must free (clHeapFree) this pointer.

Description:

This is a convenience function that returns the current configuration of the entity by calling clAmsMgmtEntityGetConfig with the correct ClAmsEntityT structure.

See Also

clAmsMgmtEntityGetConfig()

Library File:

ClAmsMgmt

ClAmsSGStatusT* clAmsMgmtServiceGroupGetStatus	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN const ClCharT *	entName
	)

Returns the current status information of a service group.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entName	NULL terminated name of the AMS entity.

Returns

A pointer to the entity's status object, or NULL. You must free (clHeapFree()) this pointer.

Description:

This is a convenience function that returns the current status of the entity by calling clAmsMgmtEntityGetStatus() with the correct ClAmsEntityT structure.

See Also

clAmsMgmtEntityGetConfig()

Library File:

ClAmsMgmt

ClAmsSIConfigT* clAmsMgmtServiceInstanceGetConfig	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN const ClCharT *	entName
	)

Returns the configuration information for a service instance.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entName	Null terminated name of the AMS entity.

Returns

NULL entity does not exist, or a pointer to the entity configuration. You must free (clHeapFree) this pointer.

Description:

This is a convenience function that returns the current configuration of the entity by calling clAmsMgmtEntityGetConfig with the correct ClAmsEntityT structure.

See Also

clAmsMgmtEntityGetConfig()

Library File:

ClAmsMgmt

ClAmsSIStatusT* clAmsMgmtServiceInstanceGetStatus	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN const ClCharT *	entName
	)

Returns the current status information of a service instance.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entName	NULL terminated name of the AMS entity.

Returns

A pointer to the entity's status object, or NULL. You must free (clHeapFree()) this pointer.

Description:

This is a convenience function that returns the current status of the entity by calling clAmsMgmtEntityGetStatus() with the correct ClAmsEntityT structure.

See Also

clAmsMgmtEntityGetConfig()

Library File:

ClAmsMgmt

ClAmsSUConfigT* clAmsMgmtServiceUnitGetConfig	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN const ClCharT *	entName
	)

Returns the configuration information for a service unit.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entName	Null terminated name of the AMS entity.

Returns

NULL entity does not exist, or a pointer to the entity configuration. You must free (clHeapFree) this pointer.

Description:

This is a convenience function that returns the current configuration of the entity by calling clAmsMgmtEntityGetConfig with the correct ClAmsEntityT structure.

See Also

clAmsMgmtEntityGetConfig()

Library File:

ClAmsMgmt

ClAmsSUStatusT* clAmsMgmtServiceUnitGetStatus	(	CL_IN ClAmsMgmtHandleT	handle,
		CL_IN const ClCharT *	entName
	)

Returns the current status information of a service unit.

Parameters

handle	Handle returned by the AML on invocation of clAmsMgmtInitialize() API.
entName	NULL terminated name of the AMS entity.

Returns

A pointer to the entity's status object, or NULL. You must free (clHeapFree()) this pointer.

Description:

This is a convenience function that returns the current status of the entity by calling clAmsMgmtEntityGetStatus() with the correct ClAmsEntityT structure.

See Also

clAmsMgmtEntityGetConfig()

Library File:

ClAmsMgmt

ClRcT clAmsMgmtSetActive	(	ClAmsMgmtHandleT	handle,
		ClAmsEntityT *	entity,
		ClAmsEntityT *	activeSU
	)

Changes the 'Active' Service Unit.

All work (SIs) assigned active in the specified SU will be moved to another specified SU.

Parameters

handle	(in) The AMS handle returned from clAmsMgmtInitialize() API.
entity	(in) A Node or SU that should become active
entity	(in) activeSU The currently active SU that will be deactivated. NULL can be passed if this is obvious (1+1 redundancy, for example).

Return values

CL_OK	The API executed successfully.
CL_CID_AMS:CL_ERR_NOT_EXIST	The entity does not exist

Description:

This API deletes the arbitrary chunk of data for all the keys associated with this entity. This data can be used by application code for any purpose.

See Also

clAmsMgmtSIAssignSU

ClRcT clAmsMgmtSGAdjust	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN const ClCharT *	sg,
		CL_IN ClBoolT	enable
	)

Restores the SG to the most preferred assignments.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
sg	Name of the SG thats being adjusted
enable	Flag indicating the auto adjustment setting on the SG

Return values

CL_OK	The function executed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMmgmtInitialize API.
CL_ERR_NOT_EXIST	Entity on which the administrative action is requested is not found in the AMS database.
CL_AMS_ERR_INVALID_ENTITY	Administrative operation is not valid for the entity type designated by type field in entity.

Description:

This administrative operation is used to restore the SG to the most preferred assignments based on the rank of the associated service units. The need for auto adjustment arises when the service unit becomes instantiable or when its readiness state is IN-SERVICE or when an service instance is UNLOCKED. If the service group becomes eligible for auto adjustment after a fault or recovery, the adjustment procedure is run on the newly repaired service units after the service groups auto-adjust probation period expires on the repaired service units. But these service units are used in other operations like switchover and failover.

Library File:

libClAmsMgmt

See Also

clAmsMgmtEntityLockAssignment(), clAmsMgmtEntityLockInstantiation(), clAmsMgmtEntityUnlock(), clAmsMgmtEntityShutdown(), clAmsMgmtEntityRestart(), clAmsMgmtEntityRepaired(), clAmsMgmtSISwap()

ClRcT clAmsMgmtSISwap	(	CL_IN ClAmsMgmtHandleT	amsHandle,
		CL_IN const ClCharT *	si
	)

Swaps the HA state of the appropriate CSIs contained within an SI.

Header File:

clAmsMgmtClientApi.h

Parameters

amsHandle	Handle identifying the initialization of the AML by the application obtained through earlier invocation of clAmsMgmtInitialize API.
si	Name of the SI thats being swapped

Return values

CL_OK	The function executed successfully.
CL_ERR_INVALID_HANDLE	Handle passed is not a valid handle obtained through an earlier call to clAmsMmgmtInitialize API.
CL_ERR_BAD_OPERATION	Swap was attempted on an SI thats not allowed. This is returned whenever SI doesnt have standby assignments or is not active or in quiescing state. Its also returned when the parent SG for the SI has a redundancy model of N WAY active or no redundancy.
CL_ERR_TRY_AGAIN	The swap cannot be performed at this time. This error is returned when the constituent service units of the SIs have instantiating/terminating or restarting presence states.
CL_ERR_NOT_EXIST	Entity on which the administrative action is requested is not found in the AMS database.
CL_AMS_ERR_INVALID_ENTITY	Administrative operation is not valid for the entity type designated by type field in entity.

Description:

This administrative operation is used to swap the ha states of the CSIs within the SI assigned to service units. It results in the interchange of HA states of the CSIs assigned to the components within a service unit. If the SI is protected by 2N redundancy model, it results in swapping of all the active and standby SIs assigned to the service unit to which the SI getting swapped is assigned. In case of M+N, it also results in swapping of all the active SIs assigned to the service unit to which the swapped SI is assigned. This operation is not supported on N-WAY active and no redundancy models. Application of this operation may potentially result in modification of the standby assignments of all the other SIs protected by the same service group but not assigned active to the service unit to which the swapped SI is assigned active.

Library File:

libClAmsMgmt

See Also

clAmsMgmtEntityLockAssignment(), clAmsMgmtEntityLockInstantiation(), clAmsMgmtEntityUnlock(), clAmsMgmtEntityShutdown(), clAmsMgmtEntityRestart() clAmsMgmtEntityRepaired()