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 
170 extern ClRcT clAmsMgmtInitialize(
171  CL_OUT ClAmsMgmtHandleT *amsHandle,
172  CL_IN const ClAmsMgmtCallbacksT *amsMgmtCallbacks,
173  CL_INOUT ClVersionT *version);
174 
175 
218 extern ClRcT clAmsMgmtFinalize(
219  CL_IN ClAmsMgmtHandleT amsHandle);
220 
221 
222 
223 /******************************************************************************
224  * Generic functions for all AMS entities
225  *****************************************************************************/
226 
302 extern ClRcT clAmsMgmtEntityLockAssignment(
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 
400 extern ClRcT clAmsMgmtEntityLockInstantiation(
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 
489 extern ClRcT clAmsMgmtEntityUnlock(
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 
578 extern ClRcT clAmsMgmtEntityShutdown(
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 
691 extern ClRcT clAmsMgmtEntityRestart(
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 
887 extern ClRcT clAmsMgmtEntityRepaired(
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 
961 extern ClRcT clAmsMgmtSISwap(
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 
1026 extern ClRcT clAmsMgmtSGAdjust(
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
1092 clAmsMgmtDebugEnable(
1093  CL_IN ClAmsMgmtHandleT amsHandle,
1094  CL_IN const ClAmsEntityT *entity,
1095  CL_IN ClUint8T debugFlags );
1096 
1097 
1098 
1151 extern ClRcT
1152 clAmsMgmtDebugDisable(
1153  CL_IN ClAmsMgmtHandleT amsHandle,
1154  CL_IN const ClAmsEntityT *entity,
1155  CL_IN ClUint8T debugFlags );
1156 
1157 
1207 extern ClRcT
1208 clAmsMgmtDebugGet(
1209  CL_IN ClAmsMgmtHandleT amsHandle,
1210  CL_IN const ClAmsEntityT *entity,
1211  CL_OUT ClUint8T *debugFlags );
1212 
1248 extern ClRcT
1249 clAmsMgmtDebugEnableLogToConsole(
1250  CL_IN ClAmsMgmtHandleT amsHandle );
1251 
1252 
1287 extern ClRcT
1288 clAmsMgmtDebugDisableLogToConsole(
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
1449 clAmsMgmtCCBInitialize(
1450  CL_IN ClAmsMgmtHandleT amlHandle,
1451  CL_OUT ClAmsMgmtCCBHandleT *ccbHandle );
1452 
1453 
1481 extern ClRcT
1482 clAmsMgmtCCBFinalize(
1483  CL_IN ClAmsMgmtCCBHandleT ccbHandle );
1484 
1485 
1518 extern ClRcT
1519 clAmsMgmtCCBCommit(
1520  CL_IN ClAmsMgmtCCBHandleT ccbHandle );
1521 
1522 
1550 extern ClRcT clAmsMgmtCCBEntityCreate(
1551  CL_IN ClAmsMgmtCCBHandleT handle,
1552  CL_IN const ClAmsEntityT *entity );
1553 
1554 
1582 extern ClRcT clAmsMgmtCCBEntityDelete(
1583  CL_IN ClAmsMgmtCCBHandleT handle,
1584  CL_IN const ClAmsEntityT *entity );
1585 
1631 extern ClRcT clAmsMgmtCCBEntitySetConfig(
1632  CL_IN ClAmsMgmtCCBHandleT handle,
1633  CL_IN ClAmsEntityConfigT *entityConfig,
1634  CL_IN ClUint64T bitMask );
1635 
1636 
1664 extern ClRcT clAmsMgmtCCBCSISetNVP(
1665  CL_IN ClAmsMgmtCCBHandleT handle,
1666  CL_IN ClAmsEntityT *csiName,
1667  CL_IN ClAmsCSINVPT *nvp );
1668 
1669 
1698 extern ClRcT clAmsMgmtCCBCSIDeleteNVP(
1699  CL_IN ClAmsMgmtCCBHandleT handle,
1700  CL_IN ClAmsEntityT *csiName,
1701  CL_IN ClAmsCSINVPT *nvp );
1702 
1703 
1737 extern ClRcT clAmsMgmtCCBSetNodeDependency(
1738  CL_IN ClAmsMgmtCCBHandleT handle,
1739  CL_IN ClAmsEntityT *nodeName,
1740  CL_IN ClAmsEntityT *dependencyNodeName );
1741 
1742 
1774 extern ClRcT clAmsMgmtCCBDeleteNodeDependency(
1775  CL_IN ClAmsMgmtCCBHandleT handle,
1776  CL_IN ClAmsEntityT *nodeName,
1777  CL_IN ClAmsEntityT *dependencyNodeName );
1778 
1779 
1812 extern ClRcT clAmsMgmtCCBSetNodeSUList(
1813  CL_IN ClAmsMgmtCCBHandleT handle,
1814  CL_IN ClAmsEntityT *nodeName,
1815  CL_IN ClAmsEntityT *suName );
1816 
1817 
1850 extern ClRcT clAmsMgmtCCBDeleteNodeSUList(
1851  CL_IN ClAmsMgmtCCBHandleT handle,
1852  CL_IN ClAmsEntityT *nodeName,
1853  CL_IN ClAmsEntityT *suName );
1854 
1855 
1889 extern ClRcT clAmsMgmtCCBSetSGSUList(
1890  CL_IN ClAmsMgmtCCBHandleT handle,
1891  CL_IN ClAmsEntityT *sgName,
1892  CL_IN ClAmsEntityT *suName );
1893 
1894 
1928 extern ClRcT clAmsMgmtCCBDeleteSGSUList(
1929  CL_IN ClAmsMgmtCCBHandleT handle,
1930  CL_IN ClAmsEntityT *sgName,
1931  CL_IN ClAmsEntityT *suName );
1932 
1933 
1966 extern ClRcT clAmsMgmtCCBSetSGSIList(
1967  CL_IN ClAmsMgmtCCBHandleT handle,
1968  CL_IN ClAmsEntityT *sgName,
1969  CL_IN ClAmsEntityT *siName );
1970 
1971 
2004 extern ClRcT clAmsMgmtCCBDeleteSGSIList(
2005  CL_IN ClAmsMgmtCCBHandleT handle,
2006  CL_IN ClAmsEntityT *sgName,
2007  CL_IN ClAmsEntityT *siName );
2008 
2009 
2044 extern ClRcT clAmsMgmtCCBSetSUCompList(
2045  CL_IN ClAmsMgmtCCBHandleT handle,
2046  CL_IN ClAmsEntityT *suName,
2047  CL_IN ClAmsEntityT *compName );
2048 
2049 
2084 extern ClRcT clAmsMgmtCCBDeleteSUCompList(
2085  CL_IN ClAmsMgmtCCBHandleT handle,
2086  CL_IN ClAmsEntityT *suName,
2087  CL_IN ClAmsEntityT *compName );
2088 
2089 
2123 extern ClRcT clAmsMgmtCCBSetSISURankList(
2124  CL_IN ClAmsMgmtCCBHandleT handle,
2125  CL_IN ClAmsEntityT *siName,
2126  CL_IN ClAmsEntityT *suName);
2127 
2128 
2162 extern ClRcT clAmsMgmtCCBDeleteSISURankList(
2163  CL_IN ClAmsMgmtCCBHandleT handle,
2164  CL_IN ClAmsEntityT *siName,
2165  CL_IN ClAmsEntityT *suName );
2166 
2199 extern ClRcT clAmsMgmtCCBSetSIDependency(
2200  CL_IN ClAmsMgmtCCBHandleT handle,
2201  CL_IN ClAmsEntityT *siName,
2202  CL_IN ClAmsEntityT *dependencySIName );
2203 
2204 
2235 extern ClRcT clAmsMgmtCCBDeleteSIDependency(
2236  CL_IN ClAmsMgmtCCBHandleT handle,
2237  CL_IN ClAmsEntityT *siName,
2238  CL_IN ClAmsEntityT *dependencySIName );
2239 
2240 
2273 extern ClRcT clAmsMgmtCCBSetCSIDependency(
2274  CL_IN ClAmsMgmtCCBHandleT handle,
2275  CL_IN ClAmsEntityT *csiName,
2276  CL_IN ClAmsEntityT *dependencyCSIName );
2277 
2308 extern ClRcT clAmsMgmtCCBDeleteCSIDependency(
2309  CL_IN ClAmsMgmtCCBHandleT handle,
2310  CL_IN ClAmsEntityT *csiName,
2311  CL_IN ClAmsEntityT *dependencyCSIName );
2312 
2313 
2347 extern ClRcT clAmsMgmtCCBSetSICSIList(
2348  CL_IN ClAmsMgmtCCBHandleT handle,
2349  CL_IN ClAmsEntityT *siName,
2350  CL_IN ClAmsEntityT *csiName );
2351 
2352 
2386 extern ClRcT clAmsMgmtCCBDeleteSICSIList(
2387  CL_IN ClAmsMgmtCCBHandleT handle,
2388  CL_IN ClAmsEntityT *siName,
2389  CL_IN ClAmsEntityT *csiName );
2390 
2391 
2408 extern ClRcT clAmsMgmtEntityGet(
2409  CL_IN ClAmsMgmtHandleT handle,
2410  CL_INOUT ClAmsEntityRefT *entityRef);
2411 
2412 
2413 
2414 
2431 extern ClRcT clAmsMgmtEntityGetConfig(
2432  CL_IN ClAmsMgmtHandleT handle,
2433  CL_IN ClAmsEntityT *entity,
2434  CL_OUT ClAmsEntityConfigT **entityConfig);
2435 
2453 extern ClAmsNodeConfigT* clAmsMgmtNodeGetConfig(
2454  CL_IN ClAmsMgmtHandleT handle,
2455  CL_IN const ClCharT *entName);
2456 
2474 extern ClAmsSGConfigT* clAmsMgmtServiceGroupGetConfig(
2475  CL_IN ClAmsMgmtHandleT handle,
2476  CL_IN const ClCharT *entName);
2477 
2495 extern ClAmsSUConfigT* clAmsMgmtServiceUnitGetConfig(
2496  CL_IN ClAmsMgmtHandleT handle,
2497  CL_IN const ClCharT *entName);
2498 
2516 extern ClAmsSIConfigT* clAmsMgmtServiceInstanceGetConfig(
2517  CL_IN ClAmsMgmtHandleT handle,
2518  CL_IN const ClCharT *entName);
2519 
2537 extern ClAmsCSIConfigT* clAmsMgmtCompServiceInstanceGetConfig(
2538  CL_IN ClAmsMgmtHandleT handle,
2539  CL_IN const ClCharT *entName);
2540 
2558 extern ClAmsCompConfigT* clAmsMgmtCompGetConfig(
2559  CL_IN ClAmsMgmtHandleT handle,
2560  CL_IN const ClCharT *entName);
2561 
2562 
2580 extern ClRcT clAmsMgmtEntityGetStatus(
2581  CL_IN ClAmsMgmtHandleT handle,
2582  CL_IN ClAmsEntityT *entity,
2583  CL_OUT ClAmsEntityStatusT **entityStatus);
2584 
2602 extern ClAmsNodeStatusT* clAmsMgmtNodeGetStatus(
2603  CL_IN ClAmsMgmtHandleT handle,
2604  CL_IN const ClCharT *entName);
2605 
2623 extern ClAmsSGStatusT* clAmsMgmtServiceGroupGetStatus(
2624  CL_IN ClAmsMgmtHandleT handle,
2625  CL_IN const ClCharT *entName);
2626 
2644 extern ClAmsSUStatusT* clAmsMgmtServiceUnitGetStatus(
2645  CL_IN ClAmsMgmtHandleT handle,
2646  CL_IN const ClCharT *entName);
2647 
2665 extern ClAmsSIStatusT* clAmsMgmtServiceInstanceGetStatus(
2666  CL_IN ClAmsMgmtHandleT handle,
2667  CL_IN const ClCharT *entName);
2668 
2686 extern ClAmsCSIStatusT* clAmsMgmtCompServiceInstanceGetStatus(
2687  CL_IN ClAmsMgmtHandleT handle,
2688  CL_IN const ClCharT *entName);
2689 
2707 extern ClAmsCompStatusT* clAmsMgmtCompGetStatus(
2708  CL_IN ClAmsMgmtHandleT handle,
2709  CL_IN const ClCharT *entName);
2710 
2730 extern ClRcT clAmsMgmtGetList(
2731  CL_IN ClAmsMgmtHandleT handle,
2732  CL_IN ClAmsEntityListTypeT listName,
2733  CL_OUT ClAmsEntityBufferT *buffer);
2734 
2735 
2753 extern ClRcT clAmsMgmtGetCSINVPList(
2754  CL_IN ClAmsMgmtHandleT handle,
2755  CL_IN ClAmsEntityT *csi,
2756  CL_OUT ClAmsCSINVPBufferT *nvpBuffer);
2757 
2776 extern ClRcT clAmsMgmtGetCSIDependenciesList(
2777  CL_IN ClAmsMgmtHandleT handle,
2778  CL_IN ClAmsEntityT *csi,
2779  CL_OUT ClAmsEntityBufferT *dependenciesCSIBuffer);
2780 
2799 extern ClRcT clAmsMgmtGetSGList(
2800  CL_IN ClAmsMgmtHandleT handle,
2801  CL_OUT ClAmsEntityBufferT *entityBuffer);
2802 
2822 extern ClRcT clAmsMgmtGetSIList(
2823  CL_IN ClAmsMgmtHandleT handle,
2824  CL_OUT ClAmsEntityBufferT *entityBuffer);
2825 
2845 extern ClRcT clAmsMgmtGetCSIList(
2846  CL_IN ClAmsMgmtHandleT handle,
2847  CL_OUT ClAmsEntityBufferT *entityBuffer);
2848 
2868 extern ClRcT clAmsMgmtGetNodeList(
2869  CL_IN ClAmsMgmtHandleT handle,
2870  CL_OUT ClAmsEntityBufferT *entityBuffer);
2871 
2891 extern ClRcT clAmsMgmtGetSUList(
2892  CL_IN ClAmsMgmtHandleT handle,
2893  CL_OUT ClAmsEntityBufferT *entityBuffer);
2894 
2914 extern ClRcT clAmsMgmtGetCompList(
2915  CL_IN ClAmsMgmtHandleT handle,
2916  CL_OUT ClAmsEntityBufferT *entityBuffer);
2917 
2918 
2938 extern ClRcT clAmsMgmtGetNodeDependenciesList(
2939  CL_IN ClAmsMgmtHandleT handle,
2940  CL_IN ClAmsEntityT *node,
2941  CL_OUT ClAmsEntityBufferT *dependencyBuffer);
2942 
2943 
2944 
2962 extern ClRcT clAmsMgmtGetNodeSUList(
2963  CL_IN ClAmsMgmtHandleT handle,
2964  CL_IN ClAmsEntityT *node,
2965  CL_OUT ClAmsEntityBufferT *suBuffer);
2966 
2967 
2987 extern ClRcT clAmsMgmtGetSGSUList(
2988  CL_IN ClAmsMgmtHandleT handle,
2989  CL_IN ClAmsEntityT *sg,
2990  CL_OUT ClAmsEntityBufferT *suBuffer);
2991 
2992 
2993 
3013 extern ClRcT clAmsMgmtGetSGSIList(
3014  CL_IN ClAmsMgmtHandleT handle,
3015  CL_IN ClAmsEntityT *sg,
3016  CL_OUT ClAmsEntityBufferT *siBuffer);
3017 
3018 
3038 extern ClRcT clAmsMgmtGetSUCompList(
3039  CL_IN ClAmsMgmtHandleT handle,
3040  CL_IN ClAmsEntityT *su,
3041  CL_OUT ClAmsEntityBufferT *compBuffer);
3042 
3043 
3044 
3062 extern ClRcT clAmsMgmtGetSISURankList(
3063  CL_IN ClAmsMgmtHandleT handle,
3064  CL_IN ClAmsEntityT *si,
3065  CL_OUT ClAmsEntityBufferT *suBuffer);
3066 
3084 extern ClRcT clAmsMgmtGetSIDependenciesList(
3085  CL_IN ClAmsMgmtHandleT handle,
3086  CL_IN ClAmsEntityT *si,
3087  CL_OUT ClAmsEntityBufferT *dependenciesSIBuffer);
3088 
3089 
3090 
3108 extern ClRcT clAmsMgmtGetSICSIList(
3109  CL_IN ClAmsMgmtHandleT handle,
3110  CL_IN ClAmsEntityT *si,
3111  CL_OUT ClAmsEntityBufferT *csiBuffer);
3112 
3113 
3114 
3132 extern ClRcT clAmsMgmtGetSGInstantiableSUList(
3133  CL_IN ClAmsMgmtHandleT handle,
3134  CL_IN ClAmsEntityT *sg,
3135  CL_OUT ClAmsEntityBufferT *instantiableSUBuffer);
3136 
3137 
3157 extern ClRcT clAmsMgmtGetSGInstantiatedSUList(
3158  CL_IN ClAmsMgmtHandleT handle,
3159  CL_IN ClAmsEntityT *sg,
3160  CL_OUT ClAmsEntityBufferT *instantiatedSUBuffer);
3161 
3162 
3180 extern ClRcT clAmsMgmtGetSGInServiceSpareSUList(
3181  CL_IN ClAmsMgmtHandleT handle,
3182  CL_IN ClAmsEntityT *sg,
3183  CL_OUT ClAmsEntityBufferT *inserviceSpareSUBuffer);
3184 
3205 extern ClRcT clAmsMgmtGetSGAssignedSUList(
3206  CL_IN ClAmsMgmtHandleT handle,
3207  CL_IN ClAmsEntityT *sg,
3208  CL_OUT ClAmsEntityBufferT *assignedSUBuffer);
3209 
3210 
3211 
3233 extern ClRcT clAmsMgmtGetSGFaultySUList(
3234  CL_IN ClAmsMgmtHandleT handle,
3235  CL_IN ClAmsEntityT *sg,
3236  CL_OUT ClAmsEntityBufferT *faultySUBuffer);
3237 
3238 
3239 
3240 
3262 extern ClRcT clAmsMgmtGetSUAssignedSIsList(
3263  CL_IN ClAmsMgmtHandleT handle,
3264  CL_IN ClAmsEntityT *su,
3265  CL_OUT ClAmsSUSIRefBufferT *siBuffer);
3266 
3267 extern ClRcT clAmsMgmtGetSUAssignedSIsExtendedList(
3268  CL_IN ClAmsMgmtHandleT handle,
3269  CL_IN ClAmsEntityT *su,
3270  CL_OUT ClAmsSUSIExtendedRefBufferT *siBuffer);
3271 
3292 extern ClRcT clAmsMgmtGetSISUList(
3293  CL_IN ClAmsMgmtHandleT handle,
3294  CL_IN ClAmsEntityT *si,
3295  CL_OUT ClAmsSISURefBufferT *suBuffer);
3296 
3297 extern ClRcT clAmsMgmtGetSISUExtendedList(
3298  CL_IN ClAmsMgmtHandleT handle,
3299  CL_IN ClAmsEntityT *si,
3300  CL_OUT ClAmsSISUExtendedRefBufferT *suBuffer);
3301 
3320 extern ClRcT clAmsMgmtGetCompCSIList(
3321  CL_IN ClAmsMgmtHandleT handle,
3322  CL_IN ClAmsEntityT *comp,
3323  CL_OUT ClAmsCompCSIRefBufferT *csiBuffer);
3324 
3325 ClRcT clAmsMgmtGetSIHAState(ClAmsMgmtHandleT handle,
3326  const ClCharT *si,
3327  const ClCharT *su,
3328  ClAmsHAStateT *haState,
3329  ClBoolT *fullyAssigned);
3330 
3331 ClRcT clAmsMgmtGetSUHAState(ClAmsMgmtHandleT handle,
3332  const ClCharT *su,
3333  ClBoolT checkAllSIs,
3334  ClAmsHAStateT *haState,
3335  ClBoolT *fullyAssigned);
3336 
3378 extern ClRcT clAmsMgmtMigrateSG(ClAmsMgmtHandleT handle,
3379  const ClCharT *sg,
3380  const ClCharT *prefix,
3381  ClUint32T activeSUs,
3382  ClUint32T standbySUs,
3383  ClAmsMgmtMigrateListT *migrateList);
3384 
3385 /*
3386  *Storing persistent entity user data for AMS entities.
3387  */
3388 
3409 extern ClRcT clAmsMgmtEntityUserDataSet(ClAmsMgmtHandleT handle,
3410  ClAmsEntityT *entity,
3411  ClCharT *data, ClUint32T len);
3412 
3413 
3437 extern ClRcT clAmsMgmtEntityUserDataSetKey(ClAmsMgmtHandleT handle,
3438  ClAmsEntityT *entity,
3439  ClNameT *key,
3440  ClCharT *data, ClUint32T len);
3462 extern ClRcT clAmsMgmtEntityUserDataGet(ClAmsMgmtHandleT handle,
3463  ClAmsEntityT *entity,
3464  ClCharT **data, ClUint32T *len);
3465 
3490 extern ClRcT clAmsMgmtEntityUserDataGetKey(ClAmsMgmtHandleT handle,
3491  ClAmsEntityT *entity,
3492  ClNameT *key,
3493  ClCharT **data, ClUint32T *len);
3494 
3512 extern ClRcT clAmsMgmtEntityUserDataDelete(ClAmsMgmtHandleT handle,
3513  ClAmsEntityT *entity);
3514 
3539 extern ClRcT clAmsMgmtEntityUserDataDeleteKey(ClAmsMgmtHandleT handle,
3540  ClAmsEntityT *entity,
3541  ClNameT *key);
3542 
3543 
3561 extern ClRcT clAmsMgmtEntityUserDataDeleteAll(ClAmsMgmtHandleT handle,
3562  ClAmsEntityT *entity);
3563 
3584 extern ClRcT clAmsMgmtSetActive(ClAmsMgmtHandleT handle, ClAmsEntityT *entity, ClAmsEntityT *activeSU);
3585 
3586 extern ClRcT clAmsMgmtSIAssignSU(const ClCharT *si, const ClCharT *activeSU, const ClCharT *standbySU);
3587 
3588 extern ClRcT clAmsMgmtGetAspInstallInfo(ClAmsMgmtHandleT handle, const ClCharT *nodeName,
3589  ClCharT *aspInstallInfo, ClUint32T len);
3590 
3591 extern ClRcT clAmsMgmtFreeCompCSIRefBuffer(ClAmsCompCSIRefBufferT *buffer);
3592 
3593 extern ClRcT clAmsMgmtDBGet(ClAmsMgmtDBHandleT *db);
3594 
3595 extern
3596 ClRcT clAmsMgmtDBGetNodeList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3597 
3598 extern
3599 ClRcT clAmsMgmtDBGetSUList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3600 
3601 extern
3602 ClRcT clAmsMgmtDBGetSGList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3603 
3604 extern
3605 ClRcT clAmsMgmtDBGetSIList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3606 
3607 extern
3608 ClRcT clAmsMgmtDBGetCSIList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3609 
3610 extern
3611 ClRcT clAmsMgmtDBGetCompList(ClAmsMgmtDBHandleT db, ClAmsEntityBufferT *buffer);
3612 
3613 extern
3614 ClRcT clAmsMgmtDBGetEntityConfig(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityConfigT **entityConfig);
3615 
3616 extern
3617 ClRcT clAmsMgmtDBGetEntityStatus(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityStatusT **entityStatus);
3618 
3619 extern
3620 ClRcT clAmsMgmtDBGetNodeSUList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3621 
3622 extern
3623 ClRcT clAmsMgmtDBGetSGSUList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3624 
3625 extern
3626 ClRcT clAmsMgmtDBGetSGSIList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3627 
3628 extern
3629 ClRcT clAmsMgmtDBGetSICSIList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3630 
3631 extern
3632 ClRcT clAmsMgmtDBGetSUCompList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsEntityBufferT *buffer);
3633 
3634 extern
3635 ClRcT clAmsMgmtDBGetSUAssignedSIsList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsSUSIExtendedRefBufferT *buffer);
3636 
3637 extern
3638 ClRcT clAmsMgmtDBGetSISUList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsSISUExtendedRefBufferT *buffer);
3639 
3640 extern
3641 ClRcT clAmsMgmtDBGetCompCSIList(ClAmsMgmtDBHandleT db, ClAmsEntityT *entity, ClAmsCompCSIRefBufferT *buffer);
3642 
3643 extern ClRcT clAmsMgmtDBCacheDump(ClAmsMgmtDBHandleT db);
3644 
3645 extern ClRcT clAmsMgmtDBFinalize(ClAmsMgmtDBHandleT *db);
3646 
3647 extern ClRcT
3648 clAmsMgmtComputedAdminStateGet(ClAmsMgmtHandleT handle,
3649  ClAmsEntityT *entity,
3650  ClAmsAdminStateT *adminState);
3651 
3652 /*
3653  * AMS mgmt CCB batch apis.
3654  */
3655 ClRcT clAmsMgmtCCBBatchInitialize(ClAmsMgmtHandleT mgmtHandle, ClAmsMgmtCCBBatchHandleT *batchHandle);
3656 
3657 ClRcT clAmsMgmtCCBBatchFinalize(ClAmsMgmtCCBBatchHandleT *batchHandle);
3658 
3659 ClRcT clAmsMgmtCCBBatchEntityCreate(ClAmsMgmtCCBBatchHandleT batchHandle,
3660  const ClAmsEntityT *entity);
3661 
3662 ClRcT clAmsMgmtCCBBatchEntityDelete(ClAmsMgmtCCBBatchHandleT batchHandle,
3663  const ClAmsEntityT *entity);
3664 
3665 ClRcT clAmsMgmtCCBBatchEntitySetConfig(ClAmsMgmtCCBBatchHandleT batchHandle,
3666  ClAmsEntityConfigT *entityConfig,
3667  ClUint64T bitmask);
3668 
3669 ClRcT clAmsMgmtCCBBatchCSISetNVP(ClAmsMgmtCCBBatchHandleT batchHandle,
3670  CL_IN ClAmsEntityT *csiName,
3671  CL_IN ClAmsCSINVPT *nvp );
3672 
3673 ClRcT clAmsMgmtCCBBatchCSIDeleteNVP(
3674  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3675  CL_IN ClAmsEntityT *csiName,
3676  CL_IN ClAmsCSINVPT *nvp );
3677 
3678 ClRcT clAmsMgmtCCBBatchSetNodeDependency(
3679  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3680  CL_IN ClAmsEntityT *nodeName,
3681  CL_IN ClAmsEntityT *dependencyNodeName );
3682 
3683 ClRcT clAmsMgmtCCBBatchDeleteNodeDependency(
3684  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3685  CL_IN ClAmsEntityT *nodeName,
3686  CL_IN ClAmsEntityT *dependencyNodeName );
3687 
3688 ClRcT clAmsMgmtCCBBatchSetNodeSUList(
3689  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3690  CL_IN ClAmsEntityT *nodeName,
3691  CL_IN ClAmsEntityT *suName);
3692 
3693 ClRcT clAmsMgmtCCBBatchDeleteNodeSUList(
3694  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3695  CL_IN ClAmsEntityT *nodeName,
3696  CL_IN ClAmsEntityT *suName );
3697 
3698 ClRcT clAmsMgmtCCBBatchSetSGSUList(
3699  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3700  CL_IN ClAmsEntityT *sgName,
3701  CL_IN ClAmsEntityT *suName);
3702 
3703 ClRcT clAmsMgmtCCBBatchDeleteSGSUList(
3704  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3705  CL_IN ClAmsEntityT *sgName,
3706  CL_IN ClAmsEntityT *suName );
3707 
3708 ClRcT clAmsMgmtCCBBatchSetSGSIList(
3709  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3710  CL_IN ClAmsEntityT *sgName,
3711  CL_IN ClAmsEntityT *siName);
3712 
3713 ClRcT clAmsMgmtCCBBatchDeleteSGSIList(
3714  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3715  CL_IN ClAmsEntityT *sgName,
3716  CL_IN ClAmsEntityT *siName);
3717 
3718 ClRcT clAmsMgmtCCBBatchSetSUCompList(
3719  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3720  CL_IN ClAmsEntityT *suName,
3721  CL_IN ClAmsEntityT *compName);
3722 
3723 ClRcT clAmsMgmtCCBBatchDeleteSUCompList(
3724  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3725  CL_IN ClAmsEntityT *suName,
3726  CL_IN ClAmsEntityT *compName);
3727 
3728 ClRcT clAmsMgmtCCBBatchSetSISURankList(
3729  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3730  CL_IN ClAmsEntityT *siName,
3731  CL_IN ClAmsEntityT *suName);
3732 
3733 ClRcT clAmsMgmtCCBBatchDeleteSISURankList(
3734  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3735  CL_IN ClAmsEntityT *siName,
3736  CL_IN ClAmsEntityT *suName);
3737 
3738 ClRcT clAmsMgmtCCBBatchSetSIDependency(
3739  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3740  CL_IN ClAmsEntityT *siName,
3741  CL_IN ClAmsEntityT *dependencySIName);
3742 
3743 ClRcT clAmsMgmtCCBBatchDeleteSIDependency(
3744  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3745  CL_IN ClAmsEntityT *siName,
3746  CL_IN ClAmsEntityT *dependencySIName);
3747 
3748 ClRcT clAmsMgmtCCBBatchSetCSIDependency(
3749  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3750  CL_IN ClAmsEntityT *csiName,
3751  CL_IN ClAmsEntityT *dependencyCSIName);
3752 
3753 ClRcT clAmsMgmtCCBBatchDeleteCSIDependency(
3754  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3755  CL_IN ClAmsEntityT *csiName,
3756  CL_IN ClAmsEntityT *dependencyCSIName);
3757 
3758 ClRcT clAmsMgmtCCBBatchSetSICSIList(
3759  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3760  CL_IN ClAmsEntityT *siName,
3761  CL_IN ClAmsEntityT *csiName);
3762 
3763 ClRcT clAmsMgmtCCBBatchDeleteSICSIList(
3764  CL_IN ClAmsMgmtCCBBatchHandleT batchHandle,
3765  CL_IN ClAmsEntityT *siName,
3766  CL_IN ClAmsEntityT *csiName);
3767 
3768 ClRcT
3769 clAmsMgmtCCBBatchCommit(CL_IN ClAmsMgmtCCBBatchHandleT batchHandle);
3770 
3771 #ifdef __cplusplus
3772 }
3773 #endif
3774 
3775 #endif /* _CL_AMS_MGMT_CLIENT_API_H_ */
3776 
3777 
Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen