Header file of AMS related APIs. More...
#include <clCommon.h>#include <clCommonErrors.h>#include <clAmsTypes.h>#include <clAmsEntities.h>#include <clAmsMgmtCommon.h>#include <clAmsMgmtHooks.h>#include <clLogApi.h>Go to the source code of this file.
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. | |
Header file of AMS related APIs.