OpenClovis Logo

clAmsMgmtClientApi.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2002-2012 OpenClovis Solutions Inc. All Rights Reserved.
3  *
4  * This file is available under a commercial license from the
5  * copyright holder or the GNU General Public License Version 2.0.
6  *
7  * The source code for this program is not published or otherwise
8  * divested of its trade secrets, irrespective of what has been
9  * deposited with the U.S. Copyright office.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * For more information, see the file COPYING provided with this
17  * material.
18  */
19 
31 /******************************************************************************
32  * TO DO ITEMS
33  * - Return values for functions are not comprehensive
34  * - Confirm how management API will be RMDized
35  *****************************************************************************/
36 
37 #ifndef _CL_AMS_MGMT_CLIENT_API_H_
38 #define _CL_AMS_MGMT_CLIENT_API_H_
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /******************************************************************************
45  * Include files needed to compile this file
46  *****************************************************************************/
47 
48 #include <clCommon.h>
49 #include <clCommonErrors.h>
50 
51 #include <clAmsTypes.h>
52 #include <clAmsEntities.h>
53 
54 // XXX Clean this up later
55 #include <clAmsMgmtCommon.h>
56 #include <clAmsMgmtHooks.h>
57 #include <clLogApi.h>
58 /******************************************************************************
59  * Management API related data structures
60  *****************************************************************************/
61 
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)) \
65  { \
66  ++(entity).name.length; \
67  } \
68 }while(0)
69 
70 typedef struct
71 {
72 #if defined (CL_AMS_MGMT_HOOKS)
73  ClRcT (*pEntityAdminResponse)
74  (ClAmsEntityTypeT type,ClAmsMgmtAdminOperT oper,ClRcT retCode);
75 #else
76  int nothingForNow;
77 #endif
78 } ClAmsMgmtCallbacksT;
79 
80 /******************************************************************************
81  * Management API functions summary
82  * --------------------------------
83  *
84  * Functions to manipulate AMS entity
85  * ----------------------------------
86  * Initialize: Initialize management api, get a handle
87  * Finalize: Finish use of management api
88  *
89  * Functions to manipulate all AMF entities
90  * ----------------------------------------
91  * Unlock: Set admin state to unlock, ie can provide service
92  * Lock: Set admin state to lock, ie cannot provide service
93  * LockAssignment: Prevent entity from accepting service assignment
94  * LockInstantiation: Prevent entity from being instantiated, same as lock
95  * Shutdown: Set admin state to shutting down
96  * Repaired: Indicate that an entity is repaired and ready
97  * Restart: Restarts the entity
98  *
99  * Note on Execution Model
100  * -----------------------
101  * Note that many of these functions result in cascading policy actions
102  * that affect a wide range of entities. Some of these operations may
103  * require a significant time to be completed. It is not necessary for
104  * a function to block until all operations are completed. A delayed
105  * callback to the management client informs it of the conclusion of
106  * the operation.
107  *****************************************************************************/
108 
109 /******************************************************************************
110  * Functions to manipulate AMS
111  *****************************************************************************/
112 
171  CL_OUT ClAmsMgmtHandleT *amsHandle,
172  CL_IN const ClAmsMgmtCallbacksT *amsMgmtCallbacks,
173  CL_INOUT ClVersionT *version);
174 
175 
219  CL_IN ClAmsMgmtHandleT amsHandle);
220 
221 
222 
223 /******************************************************************************
224  * Generic functions for all AMS entities
225  *****************************************************************************/
226 
303  CL_IN ClAmsMgmtHandleT amsHandle,
304  CL_IN const ClAmsEntityT *entity);
305 
306 extern ClRcT clAmsMgmtEntityLockAssignmentExtended(
307  CL_IN ClAmsMgmtHandleT amsHandle,
308  CL_IN const ClAmsEntityT *entity,
309  CL_IN ClBoolT retry);
310 
311 
401  CL_IN ClAmsMgmtHandleT amsHandle,
402  CL_IN const ClAmsEntityT *entity);
403 
404 extern ClRcT clAmsMgmtEntityLockInstantiationExtended(
405  CL_IN ClAmsMgmtHandleT amsHandle,
406  CL_IN const ClAmsEntityT *entity,
407  CL_IN ClBoolT retry);
408 
409 extern ClRcT clAmsMgmtEntityForceLockInstantiation(
410  CL_IN ClAmsMgmtHandleT amsHandle,
411  CL_IN const ClAmsEntityT *entity);
412 
413 extern ClRcT clAmsMgmtEntityForceLockInstantiationExtended(
414  CL_IN ClAmsMgmtHandleT amsHandle,
415  CL_IN const ClAmsEntityT *entity,
416  CL_IN ClBoolT retry);
417 
418 
490  CL_IN ClAmsMgmtHandleT amsHandle,
491  CL_IN const ClAmsEntityT *entity);
492 
493 extern ClRcT clAmsMgmtEntityUnlockExtended(
494  CL_IN ClAmsMgmtHandleT amsHandle,
495  CL_IN const ClAmsEntityT *entity,
496  CL_IN ClBoolT retry);
497 
579  CL_IN ClAmsMgmtHandleT amsHandle,
580  CL_IN const ClAmsEntityT *entity);
581 
582 extern ClRcT clAmsMgmtEntityShutdownExtended(
583  CL_IN ClAmsMgmtHandleT amsHandle,
584  CL_IN const ClAmsEntityT *entity,
585  CL_IN ClBoolT retry);
586 
692  CL_IN ClAmsMgmtHandleT amsHandle,
693  CL_IN const ClAmsEntityT *entity);
694 
695 extern ClRcT clAmsMgmtEntityRestartExtended(
696  CL_IN ClAmsMgmtHandleT amsHandle,
697  CL_IN const ClAmsEntityT *entity,
698  CL_IN ClBoolT retry);
699 
888  CL_IN ClAmsMgmtHandleT amsHandle,
889  CL_IN const ClAmsEntityT *entity);
890 
891 extern ClRcT clAmsMgmtEntityRepairedExtended(
892  CL_IN ClAmsMgmtHandleT amsHandle,
893  CL_IN const ClAmsEntityT *entity,
894  CL_IN ClBoolT retry);
895 
896 
962  CL_IN ClAmsMgmtHandleT amsHandle,
963  CL_IN const ClCharT *si);
964 
965 extern ClRcT clAmsMgmtSISwapExtended(
966  CL_IN ClAmsMgmtHandleT amsHandle,
967  CL_IN const ClCharT *si,
968  CL_IN ClBoolT retry);
969 
970 
971 
1027  CL_IN ClAmsMgmtHandleT amsHandle,
1028  CL_IN const ClCharT *sg,
1029  CL_IN ClBoolT enable);
1030 
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);
1036 
1037 
1091 extern ClRcT
1093  CL_IN ClAmsMgmtHandleT amsHandle,
1094  CL_IN const ClAmsEntityT *entity,
1095  CL_IN ClUint8T debugFlags );
1096 
1097 
1098 
1151 extern ClRcT
1153  CL_IN ClAmsMgmtHandleT amsHandle,
1154  CL_IN const ClAmsEntityT *entity,
1155  CL_IN ClUint8T debugFlags );
1156 
1157 
1207 extern ClRcT
1209  CL_IN ClAmsMgmtHandleT amsHandle,
1210  CL_IN const ClAmsEntityT *entity,
1211  CL_OUT ClUint8T *debugFlags );
1212 
1248 extern ClRcT
1250  CL_IN ClAmsMgmtHandleT amsHandle );
1251 
1252 
1287 extern ClRcT
1289  CL_IN ClAmsMgmtHandleT amsHandle );
1290 
1291 
1347 extern ClRcT
1348 clAmsMgmtEntitySetAlphaFactor( CL_IN ClAmsMgmtHandleT amsHandle,
1349  CL_IN ClAmsEntityT *entity,
1350  CL_IN ClUint32T alphaFactor );
1351 
1352 
1405 extern ClRcT
1406 clAmsMgmtEntitySetBetaFactor( CL_IN ClAmsMgmtHandleT amsHandle,
1407  CL_IN ClAmsEntityT *entity,
1408  CL_IN ClUint32T betaFactor );
1409 
1448 extern ClRcT
1450  CL_IN ClAmsMgmtHandleT amlHandle,
1451  CL_OUT ClAmsMgmtCCBHandleT *ccbHandle );
1452 
1453 
1481 extern ClRcT
1483  CL_IN ClAmsMgmtCCBHandleT ccbHandle );
1484 
1485 
1518 extern ClRcT
1520  CL_IN ClAmsMgmtCCBHandleT ccbHandle );
1521 
1522 
1551  CL_IN ClAmsMgmtCCBHandleT handle,
1552  CL_IN const ClAmsEntityT *entity );
1553 
1554 
1583  CL_IN ClAmsMgmtCCBHandleT handle,
1584  CL_IN const ClAmsEntityT *entity );
1585 
1632  CL_IN ClAmsMgmtCCBHandleT handle,
1633  CL_IN ClAmsEntityConfigT *entityConfig,
1634  CL_IN ClUint64T bitMask );
1635 
1636 
1665  CL_IN ClAmsMgmtCCBHandleT handle,
1666  CL_IN ClAmsEntityT *csiName,
1667  CL_IN ClAmsCSINVPT *nvp );
1668 
1669 
1699  CL_IN ClAmsMgmtCCBHandleT handle,
1700  CL_IN ClAmsEntityT *csiName,
1701  CL_IN ClAmsCSINVPT *nvp );
1702 
1703 
1738  CL_IN ClAmsMgmtCCBHandleT handle,
1739  CL_IN ClAmsEntityT *nodeName,
1740  CL_IN ClAmsEntityT *dependencyNodeName );
1741 
1742 
1775  CL_IN ClAmsMgmtCCBHandleT handle,
1776  CL_IN ClAmsEntityT *nodeName,
1777  CL_IN ClAmsEntityT *dependencyNodeName );
1778 
1779 
1813  CL_IN ClAmsMgmtCCBHandleT handle,
1814  CL_IN ClAmsEntityT *nodeName,
1815  CL_IN ClAmsEntityT *suName );
1816 
1817 
1851  CL_IN ClAmsMgmtCCBHandleT handle,
1852  CL_IN ClAmsEntityT *nodeName,
1853  CL_IN ClAmsEntityT *suName );
1854 
1855 
1890  CL_IN ClAmsMgmtCCBHandleT handle,
1891  CL_IN ClAmsEntityT *sgName,
1892  CL_IN ClAmsEntityT *suName );
1893 
1894 
1929  CL_IN ClAmsMgmtCCBHandleT handle,
1930  CL_IN ClAmsEntityT *sgName,
1931  CL_IN ClAmsEntityT *suName );
1932 
1933 
1967  CL_IN ClAmsMgmtCCBHandleT handle,
1968  CL_IN ClAmsEntityT *sgName,
1969  CL_IN ClAmsEntityT *siName );
1970 
1971 
2005  CL_IN ClAmsMgmtCCBHandleT handle,
2006  CL_IN ClAmsEntityT *sgName,
2007  CL_IN ClAmsEntityT *siName );
2008 
2009 
2045  CL_IN ClAmsMgmtCCBHandleT handle,
2046  CL_IN ClAmsEntityT *suName,
2047  CL_IN ClAmsEntityT *compName );
2048 
2049 
2085  CL_IN ClAmsMgmtCCBHandleT handle,
2086  CL_IN ClAmsEntityT *suName,
2087  CL_IN ClAmsEntityT *compName );
2088 
2089 
2124  CL_IN ClAmsMgmtCCBHandleT handle,
2125  CL_IN ClAmsEntityT *siName,
2126  CL_IN ClAmsEntityT *suName);
2127 
2128 
2163  CL_IN ClAmsMgmtCCBHandleT handle,
2164  CL_IN ClAmsEntityT *siName,
2165  CL_IN ClAmsEntityT *suName );
2166 
2200  CL_IN ClAmsMgmtCCBHandleT handle,
2201  CL_IN ClAmsEntityT *siName,
2202  CL_IN ClAmsEntityT *dependencySIName );
2203 
2204 
2236  CL_IN ClAmsMgmtCCBHandleT handle,
2237  CL_IN ClAmsEntityT *siName,
2238  CL_IN ClAmsEntityT *dependencySIName );
2239 
2240 
2274  CL_IN ClAmsMgmtCCBHandleT handle,
2275  CL_IN ClAmsEntityT *csiName,
2276  CL_IN ClAmsEntityT *dependencyCSIName );
2277 
2309  CL_IN ClAmsMgmtCCBHandleT handle,
2310  CL_IN ClAmsEntityT *csiName,
2311  CL_IN ClAmsEntityT *dependencyCSIName );
2312 
2313 
2348  CL_IN ClAmsMgmtCCBHandleT handle,
2349  CL_IN ClAmsEntityT *siName,
2350  CL_IN ClAmsEntityT *csiName );
2351 
2352 
2387  CL_IN ClAmsMgmtCCBHandleT handle,
2388  CL_IN ClAmsEntityT *siName,
2389  CL_IN ClAmsEntityT *csiName );
2390 
2391 
2409  CL_IN ClAmsMgmtHandleT handle,
2410  CL_INOUT ClAmsEntityRefT *entityRef);
2411 
2412 
2413 
2414 
2432  CL_IN ClAmsMgmtHandleT handle,
2433  CL_IN ClAmsEntityT *entity,
2434  CL_OUT ClAmsEntityConfigT **entityConfig);
2435 
2454  CL_IN ClAmsMgmtHandleT handle,
2455  CL_IN const ClCharT *entName);
2456 
2475  CL_IN ClAmsMgmtHandleT handle,
2476  CL_IN const ClCharT *entName);
2477 
2496  CL_IN ClAmsMgmtHandleT handle,
2497  CL_IN const ClCharT *entName);
2498 
2517  CL_IN ClAmsMgmtHandleT handle,
2518  CL_IN const ClCharT *entName);
2519 
2538  CL_IN ClAmsMgmtHandleT handle,
2539  CL_IN const ClCharT *entName);
2540 
2559  CL_IN ClAmsMgmtHandleT handle,
2560  CL_IN const ClCharT *entName);
2561 
2562 
2581  CL_IN ClAmsMgmtHandleT handle,
2582  CL_IN ClAmsEntityT *entity,
2583  CL_OUT ClAmsEntityStatusT **entityStatus);
2584 
2603  CL_IN ClAmsMgmtHandleT handle,
2604  CL_IN const ClCharT *entName);
2605 
2624  CL_IN ClAmsMgmtHandleT handle,
2625  CL_IN const ClCharT *entName);
2626 
2645  CL_IN ClAmsMgmtHandleT handle,
2646  CL_IN const ClCharT *entName);
2647 
2666  CL_IN ClAmsMgmtHandleT handle,
2667  CL_IN const ClCharT *entName);
2668 
2687  CL_IN ClAmsMgmtHandleT handle,
2688  CL_IN const ClCharT *entName);
2689 
2708  CL_IN ClAmsMgmtHandleT handle,
2709  CL_IN const ClCharT *entName);
2710 
2732  CL_IN ClAmsMgmtHandleT handle,
2733  CL_IN ClAmsEntityListTypeT listName,
2734  CL_OUT ClAmsEntityBufferT *buffer);
2735 
2736 
2755  CL_IN ClAmsMgmtHandleT handle,
2756  CL_IN ClAmsEntityT *csi,
2757  CL_OUT ClAmsCSINVPBufferT *nvpBuffer);
2758 
2778  CL_IN ClAmsMgmtHandleT handle,
2779  CL_IN ClAmsEntityT *csi,
2780  CL_OUT ClAmsEntityBufferT *dependenciesCSIBuffer);
2781 
2801  CL_IN ClAmsMgmtHandleT handle,
2802  CL_OUT ClAmsEntityBufferT *entityBuffer);
2803 
2824  CL_IN ClAmsMgmtHandleT handle,
2825  CL_OUT ClAmsEntityBufferT *entityBuffer);
2826 
2847  CL_IN ClAmsMgmtHandleT handle,
2848  CL_OUT ClAmsEntityBufferT *entityBuffer);
2849 
2870  CL_IN ClAmsMgmtHandleT handle,
2871  CL_OUT ClAmsEntityBufferT *entityBuffer);
2872 
2893  CL_IN ClAmsMgmtHandleT handle,
2894  CL_OUT ClAmsEntityBufferT *entityBuffer);
2895 
2916  CL_IN ClAmsMgmtHandleT handle,
2917  CL_OUT ClAmsEntityBufferT *entityBuffer);
2918 
2919 
2940  CL_IN ClAmsMgmtHandleT handle,
2941  CL_IN ClAmsEntityT *node,
2942  CL_OUT ClAmsEntityBufferT *dependencyBuffer);
2943 
2944 
2945 
2964  CL_IN ClAmsMgmtHandleT handle,
2965  CL_IN ClAmsEntityT *node,
2966  CL_OUT ClAmsEntityBufferT *suBuffer);
2967 
2968 
2989  CL_IN ClAmsMgmtHandleT handle,
2990  CL_IN ClAmsEntityT *sg,
2991  CL_OUT ClAmsEntityBufferT *suBuffer);
2992 
2993 
2994 
3015  CL_IN ClAmsMgmtHandleT handle,
3016  CL_IN ClAmsEntityT *sg,
3017  CL_OUT ClAmsEntityBufferT *siBuffer);
3018 
3019 
3040  CL_IN ClAmsMgmtHandleT handle,
3041  CL_IN ClAmsEntityT *su,
3042  CL_OUT ClAmsEntityBufferT *compBuffer);
3043 
3044 
3045 
3064  CL_IN ClAmsMgmtHandleT handle,
3065  CL_IN ClAmsEntityT *si,
3066  CL_OUT ClAmsEntityBufferT *suBuffer);
3067 
3086  CL_IN ClAmsMgmtHandleT handle,
3087  CL_IN ClAmsEntityT *si,
3088  CL_OUT ClAmsEntityBufferT *dependenciesSIBuffer);
3089 
3090 
3091 
3110  CL_IN ClAmsMgmtHandleT handle,
3111  CL_IN ClAmsEntityT *si,
3112  CL_OUT ClAmsEntityBufferT *csiBuffer);
3113 
3114 
3115 
3134  CL_IN ClAmsMgmtHandleT handle,
3135  CL_IN ClAmsEntityT *sg,
3136  CL_OUT ClAmsEntityBufferT *instantiableSUBuffer);
3137 
3138 
3159  CL_IN ClAmsMgmtHandleT handle,
3160  CL_IN ClAmsEntityT *sg,
3161  CL_OUT ClAmsEntityBufferT *instantiatedSUBuffer);
3162 
3163 
3182  CL_IN ClAmsMgmtHandleT handle,
3183  CL_IN ClAmsEntityT *sg,
3184  CL_OUT ClAmsEntityBufferT *inserviceSpareSUBuffer);
3185 
3207  CL_IN ClAmsMgmtHandleT handle,
3208  CL_IN ClAmsEntityT *sg,
3209  CL_OUT ClAmsEntityBufferT *assignedSUBuffer);
3210 
3211 
3212 
3235  CL_IN ClAmsMgmtHandleT handle,
3236  CL_IN ClAmsEntityT *sg,
3237  CL_OUT ClAmsEntityBufferT *faultySUBuffer);
3238 
3239 
3240 
3241 
3264  CL_IN ClAmsMgmtHandleT handle,
3265  CL_IN ClAmsEntityT *su,
3266  CL_OUT ClAmsSUSIRefBufferT *siBuffer);
3267 
3268 extern ClRcT clAmsMgmtGetSUAssignedSIsExtendedList(
3269  CL_IN ClAmsMgmtHandleT handle,
3270  CL_IN ClAmsEntityT *su,
3271  CL_OUT ClAmsSUSIExtendedRefBufferT *siBuffer);
3272 
3294  CL_IN ClAmsMgmtHandleT handle,
3295  CL_IN ClAmsEntityT *si,
3296  CL_OUT ClAmsSISURefBufferT *suBuffer);
3297 
3298 extern ClRcT clAmsMgmtGetSISUExtendedList(
3299  CL_IN ClAmsMgmtHandleT handle,
3300  CL_IN ClAmsEntityT *si,
3301  CL_OUT ClAmsSISUExtendedRefBufferT *suBuffer);
3302 
3322  CL_IN ClAmsMgmtHandleT handle,
3323  CL_IN ClAmsEntityT *comp,
3324  CL_OUT ClAmsCompCSIRefBufferT *csiBuffer);
3325 
3326 ClRcT clAmsMgmtGetSIHAState(ClAmsMgmtHandleT handle,
3327  const ClCharT *si,
3328  const ClCharT *su,
3329  ClAmsHAStateT *haState,
3330  ClBoolT *fullyAssigned);
3331 
3332 ClRcT clAmsMgmtGetSUHAState(ClAmsMgmtHandleT handle,
3333  const ClCharT *su,
3334  ClBoolT checkAllSIs,
3335  ClAmsHAStateT *haState,
3336  ClBoolT *fullyAssigned);
3337 
3379 extern ClRcT clAmsMgmtMigrateSG(ClAmsMgmtHandleT handle,
3380  const ClCharT *sg,
3381  const ClCharT *prefix,
3382  ClUint32T activeSUs,
3383  ClUint32T standbySUs,
3384  ClAmsMgmtMigrateListT *migrateList);
3385 
3386 /*
3387  *Storing persistent entity user data for AMS entities.
3388  */
3389 
3410 extern ClRcT clAmsMgmtEntityUserDataSet(ClAmsMgmtHandleT handle,
3411  ClAmsEntityT *entity,
3412  ClCharT *data, ClUint32T len);
3413 
3414 
3438 extern ClRcT clAmsMgmtEntityUserDataSetKey(ClAmsMgmtHandleT handle,
3439  ClAmsEntityT *entity,
3440  ClNameT *key,
3441  ClCharT *data, ClUint32T len);
3463 extern ClRcT clAmsMgmtEntityUserDataGet(ClAmsMgmtHandleT handle,
3464  ClAmsEntityT *entity,
3465  ClCharT **data, ClUint32T *len);
3466 
3491 extern ClRcT clAmsMgmtEntityUserDataGetKey(ClAmsMgmtHandleT handle,
3492  ClAmsEntityT *entity,
3493  ClNameT *key,
3494  ClCharT **data, ClUint32T *len);
3495 
3513 extern ClRcT clAmsMgmtEntityUserDataDelete(ClAmsMgmtHandleT handle,
3514  ClAmsEntityT *entity);
3515 
3540 extern ClRcT clAmsMgmtEntityUserDataDeleteKey(ClAmsMgmtHandleT handle,
3541  ClAmsEntityT *entity,
3542  ClNameT *key);
3543 
3544 
3562 extern ClRcT clAmsMgmtEntityUserDataDeleteAll(ClAmsMgmtHandleT handle,
3563  ClAmsEntityT *entity);
3564 
3585 extern ClRcT clAmsMgmtSetActive(ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClAmsEntityT *activeSU);
3586 
3587 extern ClRcT clAmsMgmtSIAssignSU(const ClCharT *si, const ClCharT *activeSU, const ClCharT *standbySU);
3588 
3589 extern ClRcT clAmsMgmtGetAspInstallInfo(ClAmsMgmtHandleT handle, const ClCharT *nodeName,
3590  ClCharT *aspInstallInfo, ClUint32T len);
3591 
3592 extern ClRcT clAmsMgmtFreeCompCSIRefBuffer(ClAmsCompCSIRefBufferT *buffer);
3593 
3594 extern ClRcT clAmsMgmtDBGet(ClAmsMgmtDBHandleT *db);
3595 
3596 extern
3597 ClRcT clAmsMgmtDBGetNodeList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3598 
3599 extern
3600 ClRcT clAmsMgmtDBGetSUList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3601 
3602 extern
3603 ClRcT clAmsMgmtDBGetSGList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3604 
3605 extern
3606 ClRcT clAmsMgmtDBGetSIList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3607 
3608 extern
3609 ClRcT clAmsMgmtDBGetCSIList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3610 
3611 extern
3612 ClRcT clAmsMgmtDBGetCompList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3613 
3614 extern
3615 ClRcT clAmsMgmtDBGetEntityConfig(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityConfigT **entityConfig);
3616 
3617 extern
3618 ClRcT clAmsMgmtDBGetEntityStatus(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityStatusT **entityStatus);
3619 
3620 extern
3621 ClRcT clAmsMgmtDBGetNodeSUList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3622 
3623 extern
3624 ClRcT clAmsMgmtDBGetSGSUList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3625 
3626 extern
3627 ClRcT clAmsMgmtDBGetSGSIList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3628 
3629 extern
3630 ClRcT clAmsMgmtDBGetSICSIList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3631 
3632 extern
3633 ClRcT clAmsMgmtDBGetSUCompList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3634 
3635 extern
3636 ClRcT clAmsMgmtDBGetSUAssignedSIsList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsSUSIExtendedRefBufferT *buffer);
3637 
3638 extern
3639 ClRcT clAmsMgmtDBGetSISUList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsSISUExtendedRefBufferT *buffer);
3640 
3641 extern
3642 ClRcT clAmsMgmtDBGetCompCSIList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsCompCSIRefBufferT *buffer);
3643 
3644 extern
3645 ClRcT clAmsMgmtDBGetNodeCompList(ClAmsMgmtDBHandleT cache,
3646  const ClCharT *nodeName,
3647  ClAmsEntityBufferT *compList);
3648 
3649 extern ClRcT clAmsMgmtDBCacheDump(ClAmsMgmtDBHandleT db);
3650 
3651 extern ClRcT clAmsMgmtDBFinalize(ClAmsMgmtDBHandleT *db);
3652 
3653 extern ClRcT
3654 clAmsMgmtComputedAdminStateGet(ClAmsMgmtHandleT handle,
3655  ClAmsEntityT *entity,
3656  ClAmsAdminStateT *adminState);
3657 
3658 /*
3659  * AMS mgmt CCB batch apis.
3660  */
3661 ClRcT clAmsMgmtCCBBatchInitialize(ClAmsMgmtHandleT mgmtHandle, ClAmsMgmtCCBBatchHandleT *batchHandle);
3662 
3663 ClRcT clAmsMgmtCCBBatchFinalize(ClAmsMgmtCCBBatchHandleT *batchHandle);
3664 
3665 ClRcT clAmsMgmtCCBBatchEntityCreate(ClAmsMgmtCCBBatchHandleT batchHandle,
3666  const ClAmsEntityT *entity);
3667 
3668 ClRcT clAmsMgmtCCBBatchEntityDelete(ClAmsMgmtCCBBatchHandleT batchHandle,
3669  const ClAmsEntityT *entity);
3670 
3671 ClRcT clAmsMgmtCCBBatchEntitySetConfig(ClAmsMgmtCCBBatchHandleT batchHandle,
3672  ClAmsEntityConfigT *entityConfig,
3673  ClUint64T bitmask);
3674 
3675 ClRcT clAmsMgmtCCBBatchCSISetNVP(ClAmsMgmtCCBBatchHandleT batchHandle,
3676  CL_IN ClAmsEntityT *csiName,
3677  CL_IN ClAmsCSINVPT *nvp );
3678 
3679 ClRcT clAmsMgmtCCBBatchCSIDeleteNVP(
3680  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3681  CL_IN ClAmsEntityT *csiName,
3682  CL_IN ClAmsCSINVPT *nvp );
3683 
3684 ClRcT clAmsMgmtCCBBatchSetNodeDependency(
3685  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3686  CL_IN ClAmsEntityT *nodeName,
3687  CL_IN ClAmsEntityT *dependencyNodeName );
3688 
3689 ClRcT clAmsMgmtCCBBatchDeleteNodeDependency(
3690  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3691  CL_IN ClAmsEntityT *nodeName,
3692  CL_IN ClAmsEntityT *dependencyNodeName );
3693 
3694 ClRcT clAmsMgmtCCBBatchSetNodeSUList(
3695  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3696  CL_IN ClAmsEntityT *nodeName,
3697  CL_IN ClAmsEntityT *suName);
3698 
3699 ClRcT clAmsMgmtCCBBatchDeleteNodeSUList(
3700  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3701  CL_IN ClAmsEntityT *nodeName,
3702  CL_IN ClAmsEntityT *suName );
3703 
3704 ClRcT clAmsMgmtCCBBatchSetSGSUList(
3705  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3706  CL_IN ClAmsEntityT *sgName,
3707  CL_IN ClAmsEntityT *suName);
3708 
3709 ClRcT clAmsMgmtCCBBatchDeleteSGSUList(
3710  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3711  CL_IN ClAmsEntityT *sgName,
3712  CL_IN ClAmsEntityT *suName );
3713 
3714 ClRcT clAmsMgmtCCBBatchSetSGSIList(
3715  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3716  CL_IN ClAmsEntityT *sgName,
3717  CL_IN ClAmsEntityT *siName);
3718 
3719 ClRcT clAmsMgmtCCBBatchDeleteSGSIList(
3720  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3721  CL_IN ClAmsEntityT *sgName,
3722  CL_IN ClAmsEntityT *siName);
3723 
3724 ClRcT clAmsMgmtCCBBatchSetSUCompList(
3725  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3726  CL_IN ClAmsEntityT *suName,
3727  CL_IN ClAmsEntityT *compName);
3728 
3729 ClRcT clAmsMgmtCCBBatchDeleteSUCompList(
3730  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3731  CL_IN ClAmsEntityT *suName,
3732  CL_IN ClAmsEntityT *compName);
3733 
3734 ClRcT clAmsMgmtCCBBatchSetSISURankList(
3735  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3736  CL_IN ClAmsEntityT *siName,
3737  CL_IN ClAmsEntityT *suName);
3738 
3739 ClRcT clAmsMgmtCCBBatchDeleteSISURankList(
3740  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3741  CL_IN ClAmsEntityT *siName,
3742  CL_IN ClAmsEntityT *suName);
3743 
3744 ClRcT clAmsMgmtCCBBatchSetSIDependency(
3745  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3746  CL_IN ClAmsEntityT *siName,
3747  CL_IN ClAmsEntityT *dependencySIName);
3748 
3749 ClRcT clAmsMgmtCCBBatchDeleteSIDependency(
3750  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3751  CL_IN ClAmsEntityT *siName,
3752  CL_IN ClAmsEntityT *dependencySIName);
3753 
3754 ClRcT clAmsMgmtCCBBatchSetCSIDependency(
3755  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3756  CL_IN ClAmsEntityT *csiName,
3757  CL_IN ClAmsEntityT *dependencyCSIName);
3758 
3759 ClRcT clAmsMgmtCCBBatchDeleteCSIDependency(
3760  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3761  CL_IN ClAmsEntityT *csiName,
3762  CL_IN ClAmsEntityT *dependencyCSIName);
3763 
3764 ClRcT clAmsMgmtCCBBatchSetSICSIList(
3765  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3766  CL_IN ClAmsEntityT *siName,
3767  CL_IN ClAmsEntityT *csiName);
3768 
3769 ClRcT clAmsMgmtCCBBatchDeleteSICSIList(
3770  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3771  CL_IN ClAmsEntityT *siName,
3772  CL_IN ClAmsEntityT *csiName);
3773 
3774 ClRcT
3775 clAmsMgmtCCBBatchCommit(CL_IN ClAmsMgmtCCBBatchHandleT batchHandle);
3776 
3777 #ifdef __cplusplus
3778 }
3779 #endif
3780 
3781 #endif /* _CL_AMS_MGMT_CLIENT_API_H_ */
3782 
3783 
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

Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen