37 #ifndef _CL_AMS_MGMT_CLIENT_API_H_
38 #define _CL_AMS_MGMT_CLIENT_API_H_
51 #include <clAmsTypes.h>
52 #include <clAmsEntities.h>
55 #include <clAmsMgmtCommon.h>
56 #include <clAmsMgmtHooks.h>
62 #define ASP_INSTALL_KEY "ASP_INSTALL_INFO"
63 #define CL_AMS_NAME_LENGTH_CHECK(entity) do { \
64 if((entity).name.length == strlen((entity).name.value)) \
66 ++(entity).name.length; \
72 #if defined (CL_AMS_MGMT_HOOKS)
73 ClRcT (*pEntityAdminResponse)
74 (ClAmsEntityTypeT type,ClAmsMgmtAdminOperT oper,
ClRcT retCode);
78 } ClAmsMgmtCallbacksT;
171 CL_OUT ClAmsMgmtHandleT *amsHandle,
172 CL_IN const ClAmsMgmtCallbacksT *amsMgmtCallbacks,
219 CL_IN ClAmsMgmtHandleT amsHandle);
303 CL_IN ClAmsMgmtHandleT amsHandle,
306 extern ClRcT clAmsMgmtEntityLockAssignmentExtended(
307 CL_IN ClAmsMgmtHandleT amsHandle,
309 CL_IN ClBoolT retry);
401 CL_IN ClAmsMgmtHandleT amsHandle,
404 extern ClRcT clAmsMgmtEntityLockInstantiationExtended(
405 CL_IN ClAmsMgmtHandleT amsHandle,
407 CL_IN ClBoolT retry);
409 extern ClRcT clAmsMgmtEntityForceLockInstantiation(
410 CL_IN ClAmsMgmtHandleT amsHandle,
413 extern ClRcT clAmsMgmtEntityForceLockInstantiationExtended(
414 CL_IN ClAmsMgmtHandleT amsHandle,
416 CL_IN ClBoolT retry);
490 CL_IN ClAmsMgmtHandleT amsHandle,
493 extern ClRcT clAmsMgmtEntityUnlockExtended(
494 CL_IN ClAmsMgmtHandleT amsHandle,
496 CL_IN ClBoolT retry);
579 CL_IN ClAmsMgmtHandleT amsHandle,
582 extern ClRcT clAmsMgmtEntityShutdownExtended(
583 CL_IN ClAmsMgmtHandleT amsHandle,
585 CL_IN ClBoolT retry);
692 CL_IN ClAmsMgmtHandleT amsHandle,
695 extern ClRcT clAmsMgmtEntityRestartExtended(
696 CL_IN ClAmsMgmtHandleT amsHandle,
698 CL_IN ClBoolT retry);
888 CL_IN ClAmsMgmtHandleT amsHandle,
891 extern ClRcT clAmsMgmtEntityRepairedExtended(
892 CL_IN ClAmsMgmtHandleT amsHandle,
894 CL_IN ClBoolT retry);
962 CL_IN ClAmsMgmtHandleT amsHandle,
963 CL_IN const ClCharT *si);
965 extern ClRcT clAmsMgmtSISwapExtended(
966 CL_IN ClAmsMgmtHandleT amsHandle,
967 CL_IN const ClCharT *si,
968 CL_IN ClBoolT retry);
1027 CL_IN ClAmsMgmtHandleT amsHandle,
1028 CL_IN const ClCharT *sg,
1029 CL_IN ClBoolT enable);
1031 extern ClRcT clAmsMgmtSGAdjustExtended(
1032 CL_IN ClAmsMgmtHandleT amsHandle,
1033 CL_IN const ClCharT *sg,
1034 CL_IN ClBoolT enable,
1035 CL_IN ClBoolT retry);
1093 CL_IN ClAmsMgmtHandleT amsHandle,
1095 CL_IN ClUint8T debugFlags );
1153 CL_IN ClAmsMgmtHandleT amsHandle,
1155 CL_IN ClUint8T debugFlags );
1209 CL_IN ClAmsMgmtHandleT amsHandle,
1211 CL_OUT ClUint8T *debugFlags );
1250 CL_IN ClAmsMgmtHandleT amsHandle );
1289 CL_IN ClAmsMgmtHandleT amsHandle );
1350 CL_IN ClUint32T alphaFactor );
1408 CL_IN ClUint32T betaFactor );
1450 CL_IN ClAmsMgmtHandleT amlHandle,
1451 CL_OUT ClAmsMgmtCCBHandleT *ccbHandle );
1483 CL_IN ClAmsMgmtCCBHandleT ccbHandle );
1520 CL_IN ClAmsMgmtCCBHandleT ccbHandle );
1551 CL_IN ClAmsMgmtCCBHandleT handle,
1583 CL_IN ClAmsMgmtCCBHandleT handle,
1632 CL_IN ClAmsMgmtCCBHandleT handle,
1634 CL_IN ClUint64T bitMask );
1665 CL_IN ClAmsMgmtCCBHandleT handle,
1699 CL_IN ClAmsMgmtCCBHandleT handle,
1738 CL_IN ClAmsMgmtCCBHandleT handle,
1775 CL_IN ClAmsMgmtCCBHandleT handle,
1813 CL_IN ClAmsMgmtCCBHandleT handle,
1851 CL_IN ClAmsMgmtCCBHandleT handle,
1890 CL_IN ClAmsMgmtCCBHandleT handle,
1929 CL_IN ClAmsMgmtCCBHandleT handle,
1967 CL_IN ClAmsMgmtCCBHandleT handle,
2005 CL_IN ClAmsMgmtCCBHandleT handle,
2045 CL_IN ClAmsMgmtCCBHandleT handle,
2085 CL_IN ClAmsMgmtCCBHandleT handle,
2124 CL_IN ClAmsMgmtCCBHandleT handle,
2163 CL_IN ClAmsMgmtCCBHandleT handle,
2200 CL_IN ClAmsMgmtCCBHandleT handle,
2236 CL_IN ClAmsMgmtCCBHandleT handle,
2274 CL_IN ClAmsMgmtCCBHandleT handle,
2309 CL_IN ClAmsMgmtCCBHandleT handle,
2348 CL_IN ClAmsMgmtCCBHandleT handle,
2387 CL_IN ClAmsMgmtCCBHandleT handle,
2409 CL_IN ClAmsMgmtHandleT handle,
2410 CL_INOUT ClAmsEntityRefT *entityRef);
2432 CL_IN ClAmsMgmtHandleT handle,
2454 CL_IN ClAmsMgmtHandleT handle,
2455 CL_IN const ClCharT *entName);
2475 CL_IN ClAmsMgmtHandleT handle,
2476 CL_IN const ClCharT *entName);
2496 CL_IN ClAmsMgmtHandleT handle,
2497 CL_IN const ClCharT *entName);
2517 CL_IN ClAmsMgmtHandleT handle,
2518 CL_IN const ClCharT *entName);
2538 CL_IN ClAmsMgmtHandleT handle,
2539 CL_IN const ClCharT *entName);
2559 CL_IN ClAmsMgmtHandleT handle,
2560 CL_IN const ClCharT *entName);
2581 CL_IN ClAmsMgmtHandleT handle,
2603 CL_IN ClAmsMgmtHandleT handle,
2604 CL_IN const ClCharT *entName);
2624 CL_IN ClAmsMgmtHandleT handle,
2625 CL_IN const ClCharT *entName);
2645 CL_IN ClAmsMgmtHandleT handle,
2646 CL_IN const ClCharT *entName);
2666 CL_IN ClAmsMgmtHandleT handle,
2667 CL_IN const ClCharT *entName);
2687 CL_IN ClAmsMgmtHandleT handle,
2688 CL_IN const ClCharT *entName);
2708 CL_IN ClAmsMgmtHandleT handle,
2709 CL_IN const ClCharT *entName);
2732 CL_IN ClAmsMgmtHandleT handle,
2733 CL_IN ClAmsEntityListTypeT listName,
2734 CL_OUT ClAmsEntityBufferT *buffer);
2755 CL_IN ClAmsMgmtHandleT handle,
2757 CL_OUT ClAmsCSINVPBufferT *nvpBuffer);
2778 CL_IN ClAmsMgmtHandleT handle,
2780 CL_OUT ClAmsEntityBufferT *dependenciesCSIBuffer);
2801 CL_IN ClAmsMgmtHandleT handle,
2802 CL_OUT ClAmsEntityBufferT *entityBuffer);
2824 CL_IN ClAmsMgmtHandleT handle,
2825 CL_OUT ClAmsEntityBufferT *entityBuffer);
2847 CL_IN ClAmsMgmtHandleT handle,
2848 CL_OUT ClAmsEntityBufferT *entityBuffer);
2870 CL_IN ClAmsMgmtHandleT handle,
2871 CL_OUT ClAmsEntityBufferT *entityBuffer);
2893 CL_IN ClAmsMgmtHandleT handle,
2894 CL_OUT ClAmsEntityBufferT *entityBuffer);
2916 CL_IN ClAmsMgmtHandleT handle,
2917 CL_OUT ClAmsEntityBufferT *entityBuffer);
2940 CL_IN ClAmsMgmtHandleT handle,
2942 CL_OUT ClAmsEntityBufferT *dependencyBuffer);
2964 CL_IN ClAmsMgmtHandleT handle,
2966 CL_OUT ClAmsEntityBufferT *suBuffer);
2989 CL_IN ClAmsMgmtHandleT handle,
2991 CL_OUT ClAmsEntityBufferT *suBuffer);
3015 CL_IN ClAmsMgmtHandleT handle,
3017 CL_OUT ClAmsEntityBufferT *siBuffer);
3040 CL_IN ClAmsMgmtHandleT handle,
3042 CL_OUT ClAmsEntityBufferT *compBuffer);
3064 CL_IN ClAmsMgmtHandleT handle,
3066 CL_OUT ClAmsEntityBufferT *suBuffer);
3086 CL_IN ClAmsMgmtHandleT handle,
3088 CL_OUT ClAmsEntityBufferT *dependenciesSIBuffer);
3110 CL_IN ClAmsMgmtHandleT handle,
3112 CL_OUT ClAmsEntityBufferT *csiBuffer);
3134 CL_IN ClAmsMgmtHandleT handle,
3136 CL_OUT ClAmsEntityBufferT *instantiableSUBuffer);
3159 CL_IN ClAmsMgmtHandleT handle,
3161 CL_OUT ClAmsEntityBufferT *instantiatedSUBuffer);
3182 CL_IN ClAmsMgmtHandleT handle,
3184 CL_OUT ClAmsEntityBufferT *inserviceSpareSUBuffer);
3207 CL_IN ClAmsMgmtHandleT handle,
3209 CL_OUT ClAmsEntityBufferT *assignedSUBuffer);
3235 CL_IN ClAmsMgmtHandleT handle,
3237 CL_OUT ClAmsEntityBufferT *faultySUBuffer);
3264 CL_IN ClAmsMgmtHandleT handle,
3266 CL_OUT ClAmsSUSIRefBufferT *siBuffer);
3268 extern ClRcT clAmsMgmtGetSUAssignedSIsExtendedList(
3269 CL_IN ClAmsMgmtHandleT handle,
3271 CL_OUT ClAmsSUSIExtendedRefBufferT *siBuffer);
3294 CL_IN ClAmsMgmtHandleT handle,
3296 CL_OUT ClAmsSISURefBufferT *suBuffer);
3298 extern ClRcT clAmsMgmtGetSISUExtendedList(
3299 CL_IN ClAmsMgmtHandleT handle,
3301 CL_OUT ClAmsSISUExtendedRefBufferT *suBuffer);
3322 CL_IN ClAmsMgmtHandleT handle,
3324 CL_OUT ClAmsCompCSIRefBufferT *csiBuffer);
3326 ClRcT clAmsMgmtGetSIHAState(ClAmsMgmtHandleT handle,
3329 ClAmsHAStateT *haState,
3330 ClBoolT *fullyAssigned);
3332 ClRcT clAmsMgmtGetSUHAState(ClAmsMgmtHandleT handle,
3334 ClBoolT checkAllSIs,
3335 ClAmsHAStateT *haState,
3336 ClBoolT *fullyAssigned);
3381 const ClCharT *prefix,
3382 ClUint32T activeSUs,
3383 ClUint32T standbySUs,
3384 ClAmsMgmtMigrateListT *migrateList);
3412 ClCharT *data, ClUint32T len);
3441 ClCharT *data, ClUint32T len);
3465 ClCharT **data, ClUint32T *len);
3494 ClCharT **data, ClUint32T *len);
3587 extern ClRcT clAmsMgmtSIAssignSU(
const ClCharT *si,
const ClCharT *activeSU,
const ClCharT *standbySU);
3589 extern ClRcT clAmsMgmtGetAspInstallInfo(ClAmsMgmtHandleT handle,
const ClCharT *nodeName,
3590 ClCharT *aspInstallInfo, ClUint32T len);
3592 extern ClRcT clAmsMgmtFreeCompCSIRefBuffer(ClAmsCompCSIRefBufferT *buffer);
3594 extern ClRcT clAmsMgmtDBGet(ClAmsMgmtDBHandleT *db);
3597 ClRcT clAmsMgmtDBGetNodeList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3600 ClRcT clAmsMgmtDBGetSUList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3603 ClRcT clAmsMgmtDBGetSGList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3606 ClRcT clAmsMgmtDBGetSIList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3609 ClRcT clAmsMgmtDBGetCSIList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3612 ClRcT clAmsMgmtDBGetCompList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3621 ClRcT clAmsMgmtDBGetNodeSUList(ClAmsMgmtDBHandleT db,
ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3624 ClRcT clAmsMgmtDBGetSGSUList(ClAmsMgmtDBHandleT db,
ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3627 ClRcT clAmsMgmtDBGetSGSIList(ClAmsMgmtDBHandleT db,
ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3630 ClRcT clAmsMgmtDBGetSICSIList(ClAmsMgmtDBHandleT db,
ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3633 ClRcT clAmsMgmtDBGetSUCompList(ClAmsMgmtDBHandleT db,
ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3636 ClRcT clAmsMgmtDBGetSUAssignedSIsList(ClAmsMgmtDBHandleT db,
ClAmsEntityT *entity, ClAmsSUSIExtendedRefBufferT *buffer);
3639 ClRcT clAmsMgmtDBGetSISUList(ClAmsMgmtDBHandleT db,
ClAmsEntityT *entity, ClAmsSISUExtendedRefBufferT *buffer);
3642 ClRcT clAmsMgmtDBGetCompCSIList(ClAmsMgmtDBHandleT db,
ClAmsEntityT *entity, ClAmsCompCSIRefBufferT *buffer);
3645 ClRcT clAmsMgmtDBGetNodeCompList(ClAmsMgmtDBHandleT cache,
3646 const ClCharT *nodeName,
3647 ClAmsEntityBufferT *compList);
3649 extern ClRcT clAmsMgmtDBCacheDump(ClAmsMgmtDBHandleT db);
3651 extern ClRcT clAmsMgmtDBFinalize(ClAmsMgmtDBHandleT *db);
3654 clAmsMgmtComputedAdminStateGet(ClAmsMgmtHandleT handle,
3656 ClAmsAdminStateT *adminState);
3661 ClRcT clAmsMgmtCCBBatchInitialize(ClAmsMgmtHandleT mgmtHandle, ClAmsMgmtCCBBatchHandleT *batchHandle);
3663 ClRcT clAmsMgmtCCBBatchFinalize(ClAmsMgmtCCBBatchHandleT *batchHandle);
3665 ClRcT clAmsMgmtCCBBatchEntityCreate(ClAmsMgmtCCBBatchHandleT batchHandle,
3668 ClRcT clAmsMgmtCCBBatchEntityDelete(ClAmsMgmtCCBBatchHandleT batchHandle,
3671 ClRcT clAmsMgmtCCBBatchEntitySetConfig(ClAmsMgmtCCBBatchHandleT batchHandle,
3675 ClRcT clAmsMgmtCCBBatchCSISetNVP(ClAmsMgmtCCBBatchHandleT batchHandle,
3679 ClRcT clAmsMgmtCCBBatchCSIDeleteNVP(
3680 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3684 ClRcT clAmsMgmtCCBBatchSetNodeDependency(
3685 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3689 ClRcT clAmsMgmtCCBBatchDeleteNodeDependency(
3690 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3694 ClRcT clAmsMgmtCCBBatchSetNodeSUList(
3695 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3699 ClRcT clAmsMgmtCCBBatchDeleteNodeSUList(
3700 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3704 ClRcT clAmsMgmtCCBBatchSetSGSUList(
3705 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3709 ClRcT clAmsMgmtCCBBatchDeleteSGSUList(
3710 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3714 ClRcT clAmsMgmtCCBBatchSetSGSIList(
3715 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3719 ClRcT clAmsMgmtCCBBatchDeleteSGSIList(
3720 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3724 ClRcT clAmsMgmtCCBBatchSetSUCompList(
3725 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3729 ClRcT clAmsMgmtCCBBatchDeleteSUCompList(
3730 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3734 ClRcT clAmsMgmtCCBBatchSetSISURankList(
3735 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3739 ClRcT clAmsMgmtCCBBatchDeleteSISURankList(
3740 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3744 ClRcT clAmsMgmtCCBBatchSetSIDependency(
3745 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3749 ClRcT clAmsMgmtCCBBatchDeleteSIDependency(
3750 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3754 ClRcT clAmsMgmtCCBBatchSetCSIDependency(
3755 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3759 ClRcT clAmsMgmtCCBBatchDeleteCSIDependency(
3760 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3764 ClRcT clAmsMgmtCCBBatchSetSICSIList(
3765 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3769 ClRcT clAmsMgmtCCBBatchDeleteSICSIList(
3770 CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3775 clAmsMgmtCCBBatchCommit(
CL_IN ClAmsMgmtCCBBatchHandleT batchHandle);
Typical defines found in any software project.
Common Error Codes shared across multiple Clovis ASP Components.
Header file of Log Service related APIs.
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 clAmsMgmtInitialize(CL_OUT ClAmsMgmtHandleT *amsHandle, CL_IN const ClAmsMgmtCallbacksT *amsMgmtCallbacks, CL_INOUT ClVersionT *version)
Starts the use of the management function library.
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.
ClAmsSUStatusT * clAmsMgmtServiceUnitGetStatus(CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
Returns the current status information of a service unit.
ClRcT clAmsMgmtGetCSIList(CL_IN ClAmsMgmtHandleT handle, CL_OUT ClAmsEntityBufferT *entityBuffer)
Get all component service instance entity names.
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 clAmsMgmtGetSIDependenciesList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *si, CL_OUT ClAmsEntityBufferT *dependenciesSIBuffer)
returns the si-si dependencies list for a si
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 clAmsMgmtGetCSINVPList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *csi, CL_OUT ClAmsCSINVPBufferT *nvpBuffer)
returns the name value pair list for a csi
ClRcT clAmsMgmtSISwap(CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClCharT *si)
Swaps the HA state of the appropriate CSIs contained within an SI.
ClRcT clAmsMgmtEntityUserDataGet(ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClCharT **data, ClUint32T *len)
Retrieve arbitrary data associated with 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
ClAmsSGConfigT * clAmsMgmtServiceGroupGetConfig(CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
Returns the configuration information for a service group.
ClRcT clAmsMgmtEntityUserDataDeleteAll(ClAmsMgmtHandleT handle, ClAmsEntityT *entity)
Deletes all the data associated with an AMF entity for all keys.
ClRcT clAmsMgmtGetSGSIList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *siBuffer)
returns the sg si list for a sg
ClAmsSIConfigT * clAmsMgmtServiceInstanceGetConfig(CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
Returns the configuration information for a service instance.
ClRcT clAmsMgmtGetSUAssignedSIsList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *su, CL_OUT ClAmsSUSIRefBufferT *siBuffer)
returns the assigned si's list for su
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 clAmsMgmtGetSGFaultySUList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *faultySUBuffer)
returns the faulty su list for a sg
ClRcT clAmsMgmtEntityUserDataDeleteKey(ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClNameT *key)
Deletes the arbitrary data associated with an AMF entity and a key.
ClRcT clAmsMgmtGetSGAssignedSUList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *assignedSUBuffer)
returns the assigned su list for a sg
ClRcT clAmsMgmtEntityUserDataSet(ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClCharT *data, ClUint32T len)
Associate arbitrary data with an AMF entity.
ClAmsCSIConfigT * clAmsMgmtCompServiceInstanceGetConfig(CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
Returns the configuration information for a component service instance.
ClRcT clAmsMgmtEntityRestart(CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity)
Restart an AMS entity following termination .
ClRcT clAmsMgmtEntitySetBetaFactor(CL_IN ClAmsMgmtHandleT amsHandle, CL_IN ClAmsEntityT *entity, CL_IN ClUint32T betaFactor)
Changes the beta factor configured for a given SG.
ClRcT clAmsMgmtEntityUnlock(CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity)
Changes the administrative state of an AMS entity to unlocked state.
ClRcT clAmsMgmtEntityShutdown(CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity)
Changes the administrative state of an AMS entity to shutting-down.
ClAmsCompStatusT * clAmsMgmtCompGetStatus(CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
Returns the current status information of a component.
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 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 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 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 clAmsMgmtCCBCSIDeleteNVP(CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *csiName, CL_IN ClAmsCSINVPT *nvp)
Deletes a name value pair for a CSI.
ClRcT clAmsMgmtGetSGList(CL_IN ClAmsMgmtHandleT handle, CL_OUT ClAmsEntityBufferT *entityBuffer)
Get all service group names.
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 clAmsMgmtGetSGInstantiableSUList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *instantiableSUBuffer)
returns the instantiable su list for a sg
ClAmsSIStatusT * clAmsMgmtServiceInstanceGetStatus(CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
Returns the current status information of a service instance.
ClAmsNodeConfigT * clAmsMgmtNodeGetConfig(CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
Returns the configuration information for nodes.
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 clAmsMgmtEntityUserDataGetKey(ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClNameT *key, ClCharT **data, ClUint32T *len)
Retrieve arbitrary data associated with an AMF entity and a key.
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 clAmsMgmtDebugDisable(CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity, CL_IN ClUint8T debugFlags)
Disables debugging for AMS entitity(ies).
ClRcT clAmsMgmtDebugEnable(CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity, CL_IN ClUint8T debugFlags)
Enables debugging for AMS entitity(ies).
ClRcT clAmsMgmtEntityGetConfig(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *entity, CL_OUT ClAmsEntityConfigT **entityConfig)
Returns the configuration scalar attributes of an AMF entity.
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 clAmsMgmtEntityLockAssignment(CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity)
Changes the administrative state of an AMS entity to lock assigned state.
ClAmsSGStatusT * clAmsMgmtServiceGroupGetStatus(CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
Returns the current status information of a service group.
ClRcT clAmsMgmtGetSUList(CL_IN ClAmsMgmtHandleT handle, CL_OUT ClAmsEntityBufferT *entityBuffer)
Get all service unit entity names.
ClRcT clAmsMgmtCCBFinalize(CL_IN ClAmsMgmtCCBHandleT ccbHandle)
Finalizes the AMS management control library.
ClRcT clAmsMgmtGetSICSIList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *si, CL_OUT ClAmsEntityBufferT *csiBuffer)
returns the si-csi list for a si
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 clAmsMgmtGetNodeDependenciesList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *node, CL_OUT ClAmsEntityBufferT *dependencyBuffer)
returns the node dependencies list for a node
ClRcT clAmsMgmtEntitySetAlphaFactor(CL_IN ClAmsMgmtHandleT amsHandle, CL_IN ClAmsEntityT *entity, CL_IN ClUint32T alphaFactor)
Changes the alpha factor configured for a given SG.
ClRcT clAmsMgmtGetSGInstantiatedSUList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *instantiatedSUBuffer)
returns the instantiated su list for a sg
ClRcT clAmsMgmtCCBEntityDelete(CL_IN ClAmsMgmtCCBHandleT handle, CL_IN const ClAmsEntityT *entity)
Deletes an instance of an AMS entity from AMS database.
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 clAmsMgmtEntityUserDataSetKey(ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClNameT *key, ClCharT *data, ClUint32T len)
Associate arbitrary data with an AMF entity and a key.
ClRcT clAmsMgmtGetSISUList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *si, CL_OUT ClAmsSISURefBufferT *suBuffer)
returns the su list for si
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.
ClRcT clAmsMgmtGetNodeSUList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *node, CL_OUT ClAmsEntityBufferT *suBuffer)
returns the node su list for a node
ClAmsNodeStatusT * clAmsMgmtNodeGetStatus(CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
Returns the current status information of a node.
ClRcT clAmsMgmtGetSUCompList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *su, CL_OUT ClAmsEntityBufferT *compBuffer)
returns the component list for a su
ClAmsCSIStatusT * clAmsMgmtCompServiceInstanceGetStatus(CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
Returns the current status information of a component service instance.
ClRcT clAmsMgmtGetList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityListTypeT listName, CL_OUT ClAmsEntityBufferT *buffer)
Get all entities of a particular type.
ClRcT clAmsMgmtGetCompList(CL_IN ClAmsMgmtHandleT handle, CL_OUT ClAmsEntityBufferT *entityBuffer)
Get all component entity names.
ClRcT clAmsMgmtEntityLockInstantiation(CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity)
Changes the administrative state of an AMS entity to lock instantiated state.
ClRcT clAmsMgmtFinalize(CL_IN ClAmsMgmtHandleT amsHandle)
Terminates the use of the management function library.
ClRcT clAmsMgmtGetNodeList(CL_IN ClAmsMgmtHandleT handle, CL_OUT ClAmsEntityBufferT *entityBuffer)
Get all node entity names.
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 clAmsMgmtCCBEntityCreate(CL_IN ClAmsMgmtCCBHandleT handle, CL_IN const ClAmsEntityT *entity)
Creates a new instance of an AMS entity.
ClRcT clAmsMgmtDebugGet(CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClAmsEntityT *entity, CL_OUT ClUint8T *debugFlags)
Returns the debugging flags for AMS entitity(ies).
ClRcT clAmsMgmtGetSGSUList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *sg, CL_OUT ClAmsEntityBufferT *suBuffer)
returns the sg su list for a sg
ClRcT clAmsMgmtGetSIList(CL_IN ClAmsMgmtHandleT handle, CL_OUT ClAmsEntityBufferT *entityBuffer)
Get all service instance entity names.
ClRcT clAmsMgmtDebugDisableLogToConsole(CL_IN ClAmsMgmtHandleT amsHandle)
Disables display of AMS debugging messages on the console.
ClRcT clAmsMgmtEntityGet(CL_IN ClAmsMgmtHandleT handle, CL_INOUT ClAmsEntityRefT *entityRef)
Returns the configuration and status scalar attributes of an AMS entity.
ClRcT clAmsMgmtCCBCommit(CL_IN ClAmsMgmtCCBHandleT ccbHandle)
Applies the operation specific to CCB context in AMS DB atomically.
ClRcT clAmsMgmtSetActive(ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClAmsEntityT *activeSU)
Changes the 'Active' Service Unit.
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.
ClRcT clAmsMgmtCCBInitialize(CL_IN ClAmsMgmtHandleT amlHandle, CL_OUT ClAmsMgmtCCBHandleT *ccbHandle)
Initializes the AMS management control library.
ClRcT clAmsMgmtEntityUserDataDelete(ClAmsMgmtHandleT handle, ClAmsEntityT *entity)
Deletes the data for the default key associated with an AMF entity.
ClRcT clAmsMgmtDebugEnableLogToConsole(CL_IN ClAmsMgmtHandleT amsHandle)
Enables AMS debugging messages to be displayed on the console.
ClRcT clAmsMgmtGetSISURankList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *si, CL_OUT ClAmsEntityBufferT *suBuffer)
returns the si-su rank list for a si
ClRcT clAmsMgmtSGAdjust(CL_IN ClAmsMgmtHandleT amsHandle, CL_IN const ClCharT *sg, CL_IN ClBoolT enable)
Restores the SG to the most preferred assignments.
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 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 clAmsMgmtCCBDeleteSGSUList(CL_IN ClAmsMgmtCCBHandleT handle, CL_IN ClAmsEntityT *sgName, CL_IN ClAmsEntityT *suName)
Deletes a SU from the SU list of an AMS SG.
ClAmsCompConfigT * clAmsMgmtCompGetConfig(CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
Returns the configuration information for a component.
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 clAmsMgmtGetCSIDependenciesList(CL_IN ClAmsMgmtHandleT handle, CL_IN ClAmsEntityT *csi, CL_OUT ClAmsEntityBufferT *dependenciesCSIBuffer)
returns the csi-csi dependencies list for a csi
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.
ClAmsSUConfigT * clAmsMgmtServiceUnitGetConfig(CL_IN ClAmsMgmtHandleT handle, CL_IN const ClCharT *entName)
Returns the configuration information for a service unit.
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.
ClUint32T ClRcT
Clovis return code type.
Definition: clCommon.h:168
#define CL_INOUT
CL_INOUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:108
#define CL_OUT
CL_OUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:110
#define CL_IN
CL_IN macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:106
A name.
Definition: clCommon.h:197
Version Information for various services.
Definition: clCommon.h:250
This structure represents a reference to an AMF entity.
Definition: clAmsEntities.h:110
This structure is the common fields in all AMF entities' status.
Definition: clAmsEntities.h:124
Node configuration information.
Definition: clAmsEntities.h:381
Node state information.
Definition: clAmsEntities.h:403
Service group configuration information.
Definition: clAmsEntities.h:466
Service group state information.
Definition: clAmsEntities.h:521
Service Unit configuration information.
Definition: clAmsEntities.h:603
Service Unit status information.
Definition: clAmsEntities.h:623
Service Unit configuration information.
Definition: clAmsEntities.h:695
Service Unit state information.
Definition: clAmsEntities.h:715
Component configuration information.
Definition: clAmsEntities.h:785
Component state information.
Definition: clAmsEntities.h:815
Name Value Pair definition for CSIs.
Definition: clAmsEntities.h:898
Component service instance configuration information.
Definition: clAmsEntities.h:908
Component service instance state information.
Definition: clAmsEntities.h:926