Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.13.1.2
openapi_stacking.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2023 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_stacking.h
28 *
29 * @purpose Stacking Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 10/22/2015
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_STACKING_H_INCLUDED
39 #define OPENAPI_STACKING_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
44 typedef enum
45 {
46  OPEN_USMDB_UNITMGR_UNIT_OK = 1,
47  OPEN_USMDB_UNITMGR_UNIT_UNSUPPORTED = 2,
48  OPEN_USMDB_UNITMGR_CODE_MISMATCH = 3,
49  OPEN_USMDB_UNITMGR_CFG_MISMATCH = 4,
50  OPEN_USMDB_UNITMGR_SDM_MISMATCH = 5,
51  OPEN_USMDB_UNITMGR_UNIT_NOT_PRESENT = 6,
52  OPEN_USMDB_UNITMGR_CODE_UPDATE = 7,
53  OPEN_USMDB_UNITMGR_STM_MISMATCH = 8
54 } OPEN_USMDB_UNITMGR_STATUS_t;
55 
57 typedef enum
58 {
59  OPEN_USMDB_UNITMGR_MGMT_ENABLED = 1,
60  OPEN_USMDB_UNITMGR_MGMT_DISABLED = 2,
61  OPEN_USMDB_UNITMGR_MGMT_UNASSIGNED = 3
62 } OPEN_USMDB_UNITMGR_MGMT_FLAG_t;
63 
65 typedef enum
66 {
67  OPEN_USMDB_UNITMGR_MGMTPREF_DISABLED = 0,
68  OPEN_USMDB_UNITMGR_MGMTPREF_1 = 1,
69  OPEN_USMDB_UNITMGR_MGMTPREF_2 = 2,
70  OPEN_USMDB_UNITMGR_MGMTPREF_3 = 3,
71  OPEN_USMDB_UNITMGR_MGMTPREF_4 = 4,
72  OPEN_USMDB_UNITMGR_MGMTPREF_5 = 5,
73  OPEN_USMDB_UNITMGR_MGMTPREF_6 = 6,
74  OPEN_USMDB_UNITMGR_MGMTPREF_7 = 7,
75  OPEN_USMDB_UNITMGR_MGMTPREF_8 = 8,
76  OPEN_USMDB_UNITMGR_MGMTPREF_9 = 9,
77  OPEN_USMDB_UNITMGR_MGMTPREF_10 = 10,
78  OPEN_USMDB_UNITMGR_MGMTPREF_11 = 11,
79  OPEN_USMDB_UNITMGR_MGMTPREF_12 = 12,
80  OPEN_USMDB_UNITMGR_MGMTPREF_13 = 13,
81  OPEN_USMDB_UNITMGR_MGMTPREF_14 = 14,
82  OPEN_USMDB_UNITMGR_MGMTPREF_15 = 15,
83  OPEN_USMDB_UNITMGR_MGMTFUNC_UNASSIGNED = 16
84 } OPEN_USMDB_UNITMGR_MGMTPREF_t;
85 
87 typedef enum
88 {
89  OPEN_SFS_SWITCH_STATUS_NO_ACTION = 1,
90  OPEN_SFS_SWITCH_STATUS_IN_PROGRESS = 2
91 } OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t;
92 
94 typedef enum
95 {
96  OPEN_SFS_NONE = 1,
97  OPEN_SFS_SUCCESS = 2,
98  OPEN_SFS_FAIL = 3,
99  OPEN_SFS_MIN_BOOTCODE_VERSION_NOT_PRESENT = 4
100 } OPEN_SFS_LAST_ATTEMPT_STATUS_t;
101 
103 typedef enum
104 {
105  OPEN_STACK_SPEED_10G = 0,
106  OPEN_STACK_SPEED_25G,
107  OPEN_STACK_SPEED_40G,
108  OPEN_STACK_SPEED_50G,
109  OPEN_STACK_SPEED_100G,
110 }OPEN_STACK_SPEED_t;
111 
112 typedef enum
113 {
114  OPEN_UNITMGR_ROOTFS_SYNCED = 1,
115  OPEN_UNITMGR_ROOTFS_OUT_OF_SYNC,
116  OPEN_UNITMGR_ROOTFS_COPIED
117 } OPEN_UNIT_MGR_ROOTFS_STATUS_t;
118 
119 typedef enum
120 {
121  OPEN_UNIT_STATUS_SAMPLEMODE_NONE,
122  OPEN_UNIT_STATUS_SAMPLEMODE_CUMULATIVESUMMING,
123  OPEN_UNIT_STATUS_SAMPLEMODE_HISTORY,
124  OPEN_UNIT_STATUS_SAMPLEMODE_MAX,
125 } openUnitStatusSampleMode_t;
126 
127 typedef enum
128 {
130  OPEN_RUN_CFG_NONE = 0,
132  OPEN_RUN_CFG_STALE,
134  OPEN_RUN_CFG_IN_PROGRESS,
136  OPEN_RUN_CFG_CURRENT,
138  OPEN_RUN_CFG_NO_BACKUP
139 } OPEN_RUN_CFG_STATUS_t;
140 
141 typedef enum
142 {
145  OPEN_STARTUP_POWER_ON = 0,
147  OPEN_STARTUP_COLD_ADMIN_MOVE,
150  OPEN_STARTUP_WARM_ADMIN_MOVE,
153  OPEN_STARTUP_AUTO_WARM,
158  OPEN_STARTUP_AUTO_COLD
159 } OPEN_LAST_STARTUP_REASON_t;
160 
161 #define OPEN_UNITMGR_ROOTFS_VER_SIZE 33
162 #define OPEN_UNITMGR_ROOTFS_VER_LENGTH 32
163 #define OPEN_UNITMGR_ROOTFS_SNAPSHOT_FILE "/mnt/fastpath/upper1.tgz"
164 #define OPEN_UNITMGR_ROOTFS_SNAPSHOT_VER_FILE "/mnt/fastpath/upper1.md5"
165 #define OPEN_CDA_FILE_NAME_LENGTH 128
166 #define OPEN_UNITMGR_ROOTFS_COMPAT_FILE "/etc/bootstrap-distro-compat"
167 #define OPEN_UNITMGR_ROOTFS_SNAPSHOT_FILE_NAME_LENGTH 64
168 #define OPEN_UNITMGR_ROOTFS_SNAPSHOT_VERSION_FILE_NAME_LENGTH 64
169 #define OPEN_UNITMGR_LEGACY_ROOTFS_COMPAT_STRING "1"
170 #define OPEN_UNITMGR_ROOTFS_COMPAT_STRING_LENGTH 32
171 #define OPEN_MAX_UNITS_PER_STACK 12
172 #define OPEN_ALL_UNITS (OPEN_MAX_UNITS_PER_STACK + 1)
173 
174 typedef struct openUnitStatusInfo_s
175 {
176  uint32_t unit;
177  OPEN_BOOL_t isValid;
178  uint32_t avgTimeOffset;
179  uint32_t minTimeOffset;
180  uint32_t maxTimeOffset;
181  uint32_t curTimeOffset;
182  uint32_t lostMsgs;
183 } openUnitStatusInfo_t;
184 
185 typedef struct openUnitStatusUnitInfo_s
186 {
187  uint32_t unit;
188  openUnitStatusSampleMode_t sampleMode;
189  uint32_t sampleSize;
190  openUnitStatusInfo_t status_info[OPEN_MAX_UNITS_PER_STACK];
191 } openUnitStatusUnitInfo_t;
192 
193 /*****************************************************************/
208 open_error_t openapiUnitMgrStackMemberGetNext(openapiClientHandle_t *client_handle,
209  uint32_t startUnit,
210  uint32_t *nextUnit);
211 
212 /*****************************************************************/
226 open_error_t openapiUnitMgrNumberGet(openapiClientHandle_t *client_handle,
227  uint32_t *unit);
228 
229 /*****************************************************************/
246 open_error_t openapiUnitMgrSerialNumberGet(openapiClientHandle_t *client_handle,
247  uint32_t unit,
248  open_buffdesc *serialNumber);
249 
250 /*****************************************************************/
267 open_error_t openapiUnitMgrServiceTagGet(openapiClientHandle_t *client_handle,
268  uint32_t unit,
269  open_buffdesc *serviceTag);
270 
271 /*****************************************************************/
289 open_error_t openapiUnitMgrPreconfigModelIdGet(openapiClientHandle_t *client_handle,
290  uint32_t unit,
291  open_buffdesc *modelId);
292 
293 /*****************************************************************/
309 open_error_t openapiUnitMgrUnitIsValid(openapiClientHandle_t *client_handle,
310  uint32_t unit,
311  OPEN_BOOL_t *isValid);
312 
313 /*****************************************************************/
328 open_error_t openapiUnitMgrUnitMaxGet(openapiClientHandle_t *client_handle,
329  uint32_t *unit);
330 
331 /*****************************************************************/
346 open_error_t openapiUnitMgrUnitStatusGet(openapiClientHandle_t *client_handle,
347  uint32_t unit,
348  OPEN_USMDB_UNITMGR_STATUS_t *status);
349 
350 /*****************************************************************/
365 open_error_t openapiUnitMgrMgmtUnitStatusGet(openapiClientHandle_t *client_handle,
366  uint32_t unit,
367  OPEN_USMDB_UNITMGR_MGMT_FLAG_t *mgmtStatus);
368 
369 /*****************************************************************/
390 open_error_t openapiUnitMgrModelIdentifierGet(openapiClientHandle_t *client_handle,
391  uint32_t unit,
392  open_buffdesc *modelId,
393  open_buffdesc *preconfigModelId);
394 
395 /*****************************************************************/
410 open_error_t openapiUnitMgrDetectCodeVerFlashGet(openapiClientHandle_t *client_handle,
411  uint32_t unit,
412  open_revision_data_t *codeVersion);
413 
414 /*****************************************************************/
429 open_error_t openapiUnitMgrDetectCodeVerRunningGet(openapiClientHandle_t *client_handle,
430  uint32_t unit,
431  open_revision_data_t *codeVersion);
432 
433 /*****************************************************************/
449 open_error_t openapiUnitMgrMgmtPrefGet(openapiClientHandle_t *client_handle,
450  uint32_t unit,
451  OPEN_USMDB_UNITMGR_MGMTPREF_t *hwPref,
452  OPEN_USMDB_UNITMGR_MGMTPREF_t *adminPref);
453 
454 /*****************************************************************/
471 open_error_t openapiUnitMgrUnitTypeGet(openapiClientHandle_t *client_handle,
472  uint32_t unit,
473  uint32_t *unitType,
474  uint32_t *unitTypeIndex);
475 
476 /*****************************************************************/
493 open_error_t openapiUnitMgrSupportedDescriptionGet(openapiClientHandle_t *client_handle,
494  uint32_t unitTypeIndex,
495  open_buffdesc *unitDescr);
496 
497 /*****************************************************************/
512 open_error_t openapiUnitMgrStackFirmwareSyncMemberStatusGet(openapiClientHandle_t *client_handle,
513  uint32_t unit,
514  OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t *firmwareSyncStatus);
515 
516 /*****************************************************************/
531 open_error_t openapiUnitMgrStackFirmwareSyncStatusGet(openapiClientHandle_t *client_handle,
532  OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t *firmwareSyncStatus);
533 
534 /*****************************************************************/
550 open_error_t openapiUnitMgrStackFirmwareSyncMemberLastAttemptStatusGet(openapiClientHandle_t *client_handle,
551  uint32_t unit,
552  uint32_t *lastAttemptStatus);
553 
554 /*****************************************************************/
570 open_error_t openapiStmUnitActiveTemplateIdGet(openapiClientHandle_t *client_handle,
571  uint32_t unit,
572  uint32_t *templateId);
573 
574 /*****************************************************************/
590 open_error_t openapiStmTemplateDescriptionGet(openapiClientHandle_t *client_handle,
591  uint32_t templateId,
592  open_buffdesc *templateDescr);
593 
594 /*****************************************************************/
609 open_error_t openapiUnitMgrUnitUpTimeGet(openapiClientHandle_t *client_handle,
610  uint32_t unit,
611  uint32_t *upTime);
612 
613 /*****************************************************************/
630 open_error_t openapiUnitMgrSupportedUnitIdGet(openapiClientHandle_t *client_handle,
631  uint32_t unitTypeIndex,
632  uint32_t *unitType);
633 
634 /*****************************************************************/
652 open_error_t openapiUnitMgrSupportedUnitIdNextGet(openapiClientHandle_t *client_handle,
653  uint32_t unitTypeIndex,
654  uint32_t *nextUnitTypeIndex,
655  uint32_t *unitType);
656 
657 /*****************************************************************/
677 open_error_t openapiUnitMgrUnitCreate(openapiClientHandle_t *client_handle,
678  uint32_t unit,
679  uint32_t unitTypeIndex,
680  OPEN_BOOL_t synchMode);
681 
682 /*****************************************************************/
698 open_error_t openapiUnitMgrUnitDelete(openapiClientHandle_t *client_handle,
699  uint32_t unit);
700 
701 /*****************************************************************/
717 open_error_t openapiUnitMgrUnitTransfer(openapiClientHandle_t *client_handle,
718  uint32_t targetUnit);
719 
720 /*****************************************************************/
737 open_error_t openapiSpmFpsConfigQosModeGet(openapiClientHandle_t *client_handle,
738  OPEN_CONTROL_t *fpsQosMode);
739 
740 /*****************************************************************/
756 open_error_t openapiSpmFpsConfigQosModeSet(openapiClientHandle_t *client_handle,
757  OPEN_CONTROL_t fpsQosMode);
758 
759 /*****************************************************************/
776 open_error_t openapiUnitMgrStandbyGet(openapiClientHandle_t *client_handle,
777  uint32_t *configUnit,
778  uint32_t *standbyUnit,
779  OPEN_BOOL_t *standbyAdminMode);
780 
781 /*****************************************************************/
796 open_error_t openapiUnitMgrStandbySet(openapiClientHandle_t *client_handle,
797  uint32_t standbyUnit,
798  OPEN_BOOL_t standbyAdminMode);
799 
800 /*****************************************************************/
820 open_error_t openapiSpmFpsConfigStackingModeGet(openapiClientHandle_t *client_handle,
821  uint32_t unit,
822  uint32_t slot,
823  uint32_t port,
824  OPEN_BOOL_t *stackPortMode);
825 
826 /*****************************************************************/
845 open_error_t openapiSpmFpsConfigStackingModeSet(openapiClientHandle_t *client_handle,
846  uint32_t unit,
847  uint32_t slot,
848  uint32_t port,
849  OPEN_BOOL_t stackPortMode);
850 
851 
852 
853 /*****************************************************************/
870 open_error_t openapiSlotGet(openapiClientHandle_t *client_handle,
871  uint32_t unit,
872  uint32_t slot,
873  OPEN_BOOL_t *isValid);
874 
875 /**********************************************************************/
893 open_error_t openapiUnitDbEntrySlotsGet(openapiClientHandle_t *client_handle,
894  uint32_t unit,
895  uint32_t *count,
896  open_buffdesc *bufd);
897 
898 /*****************************************************************/
917 open_error_t openapiSlotIsFullGet(openapiClientHandle_t *client_handle,
918  uint32_t unit,
919  uint32_t slot,
920  OPEN_BOOL_t *isFull);
921 
922 /*****************************************************************/
942 open_error_t openapiSlotAdminModeGet(openapiClientHandle_t *client_handle,
943  uint32_t unit,
944  uint32_t slot,
945  OPEN_CONTROL_t *adminMode);
946 
947 /*****************************************************************/
967 open_error_t openapiSlotAdminModeSet(openapiClientHandle_t *client_handle,
968  uint32_t unit,
969  uint32_t slot,
970  OPEN_CONTROL_t adminMode);
971 
972 /*****************************************************************/
992 open_error_t openapiSlotPowerModeGet(openapiClientHandle_t *client_handle,
993  uint32_t unit,
994  uint32_t slot,
995  OPEN_CONTROL_t *powerMode);
996 
997 /*****************************************************************/
1017 open_error_t openapiSlotPowerModeSet(openapiClientHandle_t *client_handle,
1018  uint32_t unit,
1019  uint32_t slot,
1020  OPEN_CONTROL_t powerMode);
1021 
1022 /*****************************************************************/
1041 open_error_t openapiCardTypeGet(openapiClientHandle_t *client_handle,
1042  uint32_t unit,
1043  uint32_t slot,
1044  uint32_t *cardIdConfig,
1045  uint32_t *cardIdInsert);
1046 
1047 /*****************************************************************/
1064 open_error_t openapiCardSupportedCardModelIdGet(openapiClientHandle_t *client_handle,
1065  uint32_t cardId,
1066  open_buffdesc *bufd);
1067 
1068 /*****************************************************************/
1085 open_error_t openapiCardSupportedCardDescriptionGet(openapiClientHandle_t *client_handle,
1086  uint32_t cardId,
1087  open_buffdesc *bufd);
1088 
1089 /*****************************************************************/
1108 open_error_t openapiSlotSupportedPluggableGet(openapiClientHandle_t *client_handle,
1109  uint32_t unit,
1110  uint32_t slot,
1111  OPEN_BOOL_t *isPluggable);
1112 
1113 /*****************************************************************/
1132 open_error_t openapiSlotSupportedPowerdownGet(openapiClientHandle_t *client_handle,
1133  uint32_t unit,
1134  uint32_t slot,
1135  OPEN_BOOL_t *isPowerdown);
1136 
1137 /*****************************************************************/
1161 open_error_t openapiCdaTransferFile(openapiClientHandle_t *client_handle,
1162  uint32_t unit,
1163  open_buffdesc *srcFileName,
1164  open_buffdesc *dstFileName);
1165 
1166 /*****************************************************************/
1185 open_error_t openapiUnitMgrDebianRootfsVerGet(openapiClientHandle_t *client_handle,
1186  uint32_t unit,
1187  open_buffdesc *version);
1188 
1189 /*****************************************************************/
1208 open_error_t openapiUnitMgrDebianRootfsVerSet(openapiClientHandle_t *client_handle,
1209  uint32_t unit,
1210  open_buffdesc *version);
1211 
1212 /*****************************************************************/
1231 open_error_t openapiUnitMgrDebianRootfsOperVerGet(openapiClientHandle_t *client_handle,
1232  uint32_t unit,
1233  open_buffdesc *version);
1234 
1235 /*****************************************************************/
1254 open_error_t openapiUnitMgrDebianRootfsOperVerSet(openapiClientHandle_t *client_handle,
1255  uint32_t unit,
1256  open_buffdesc *version);
1257 
1258 /*****************************************************************/
1273 open_error_t openapiUnitMgrResetUnit(openapiClientHandle_t *client_handle,
1274  uint32_t unit);
1275 
1276 /*****************************************************************/
1293 open_error_t openapiUnitMgrDebianRootfsFileNameGet(openapiClientHandle_t *client_handle,
1294  uint32_t unit,
1295  open_buffdesc *filename);
1296 
1297 /*****************************************************************/
1314 open_error_t openapiUnitMgrDebianRootfsVersionFileNameGet(openapiClientHandle_t *client_handle,
1315  uint32_t unit,
1316  open_buffdesc *filename);
1317 
1318 /*****************************************************************/
1337 open_error_t openapiSpmFpsStackingRunningSpeedGet(openapiClientHandle_t *client_handle,
1338  uint32_t unit,
1339  uint32_t slot,
1340  uint32_t port,
1341  OPEN_STACK_SPEED_t *stackPortSpeed);
1342 
1343 /*****************************************************************/
1362 open_error_t openapiSpmFpsStackingConfigSpeedGet(openapiClientHandle_t *client_handle,
1363  uint32_t unit,
1364  uint32_t slot,
1365  uint32_t port,
1366  OPEN_STACK_SPEED_t *stackPortSpeed);
1367 
1368 /*****************************************************************/
1387 open_error_t openapiSpmFpsStackingConfigSpeedSet(openapiClientHandle_t *client_handle,
1388  uint32_t unit,
1389  uint32_t slot,
1390  uint32_t port,
1391  OPEN_STACK_SPEED_t stackPortSpeed);
1392 
1393 /*****************************************************************/
1407 open_error_t openapiUnitMgrSupportedLocalUnitIndexGet(openapiClientHandle_t *client_handle,
1408  uint32_t *unitTypeIdIndex);
1409 
1410 /*****************************************************************/
1425 open_error_t openapiUnitMgrSupportedModelGet(openapiClientHandle_t *client_handle,
1426  uint32_t unitTypeIdIndex,
1427  open_buffdesc *unitModel);
1428 
1429 /*****************************************************************/
1445 open_error_t openapiUnitMgrSupportedStmDefaultTemplateIdGet(openapiClientHandle_t *client_handle,
1446  uint32_t unitTypeIdIndex,
1447  uint32_t *defaultTemplateId);
1448 
1449 /*****************************************************************/
1464 open_error_t openapiUnitMgrSupportedMgmtPrefGet(openapiClientHandle_t *client_handle,
1465  uint32_t unitTypeIdIndex,
1466  uint32_t *unitMgmtPref);
1467 
1468 /*****************************************************************/
1482 open_error_t openapiUnitMgrStackMemberGetFirst(openapiClientHandle_t *client_handle,
1483  uint32_t *firstUnit);
1484 
1485 /*****************************************************************/
1500 open_error_t openapiUnitMgrUnitIdKeyGet(openapiClientHandle_t *client_handle,
1501  uint32_t unit, open_buffdesc *key);
1502 
1503 /*****************************************************************/
1518 open_error_t openapiUnitMgrAdminMgmtPrefSet(openapiClientHandle_t *client_handle,
1519  uint32_t unit,
1520  OPEN_USMDB_UNITMGR_MGMTPREF_t adminPref);
1521 
1522 /*****************************************************************/
1535 open_error_t openapiFailoverInitiate(openapiClientHandle_t *client_handle);
1536 
1537 /*****************************************************************/
1552 open_error_t openapiUnitMgrNsfAdminSet(openapiClientHandle_t *client_handle,
1553  OPEN_CONTROL_t nsf);
1554 
1555 /*****************************************************************/
1570 open_error_t openapiUnitMgrNsfAdminGet(openapiClientHandle_t *client_handle,
1571  OPEN_CONTROL_t *nsf);
1572 
1573 /*****************************************************************/
1588 open_error_t openapiUnitMgrStartupReasonGet(openapiClientHandle_t *client_handle,
1589  OPEN_LAST_STARTUP_REASON_t *reason);
1590 
1591 /*****************************************************************/
1607 open_error_t openapiUnitMgrStartupReasonStrGet(openapiClientHandle_t *client_handle,
1608  OPEN_LAST_STARTUP_REASON_t reason,
1609  open_buffdesc *reasonStr);
1610 
1611 /*****************************************************************/
1627 open_error_t openapiUnitMgrRunCfgStatusString(openapiClientHandle_t *client_handle,
1628  OPEN_RUN_CFG_STATUS_t runCfgStatus,
1629  open_buffdesc *statusStr);
1630 
1631 /*****************************************************************/
1646 open_error_t openapiUnitMgrConfigAgeOnBackup(openapiClientHandle_t *client_handle,
1647  uint32_t *age);
1648 
1649 /*****************************************************************/
1664 open_error_t openapixUnitMgrRunCfgStatusGet(openapiClientHandle_t *client_handle,
1665  OPEN_RUN_CFG_STATUS_t *status);
1666 
1667 /*****************************************************************/
1683 open_error_t openapiUnitMgrNextConfigCopyTime(openapiClientHandle_t *client_handle,
1684  uint32_t *wait);
1685 
1686 /*****************************************************************/
1702 open_error_t openapiUnitMgrNsfSupportGet(openapiClientHandle_t *client_handle,
1703  uint32_t unit,
1704  OPEN_BOOL_t *nsfSupport);
1705 
1706 /*****************************************************************/
1723 open_error_t openapiUnitMgrUnitNumberChange(openapiClientHandle_t *client_handle,
1724  uint32_t unit,
1725  uint32_t newUnitNumber);
1726 
1727 /*****************************************************************/
1740 open_error_t openapiUnitMgrEraseStartupConfig(openapiClientHandle_t *client_handle);
1741 
1742 /*****************************************************************/
1755 open_error_t openapiUnitMgrEraseFactoryDefaults(openapiClientHandle_t *client_handle);
1756 
1757 /*****************************************************************/
1772 open_error_t openapiUnitMgrUserDescriptionSet(openapiClientHandle_t *client_handle,
1773  uint32_t unit,
1774  open_buffdesc *descr);
1775 
1776 /*****************************************************************/
1791 open_error_t openapiUnitMgrUserDescriptionGet(openapiClientHandle_t *client_handle,
1792  uint32_t unit,
1793  open_buffdesc *descr);
1794 
1795 /*****************************************************************/
1809 open_error_t openapiUnitMgrStackFirmwareSyncModeGet(openapiClientHandle_t *client_handle,
1810  OPEN_CONTROL_t *mode);
1811 
1812 /*****************************************************************/
1826 open_error_t openapiUnitMgrStackFirmwareSyncModeSet(openapiClientHandle_t *client_handle,
1827  OPEN_CONTROL_t mode);
1828 
1829 /*****************************************************************/
1843 open_error_t openapiUnitMgrStackFirmwareSyncTrapModeGet(openapiClientHandle_t *client_handle,
1844  OPEN_CONTROL_t *mode);
1845 
1846 /*****************************************************************/
1860 open_error_t openapiUnitMgrStackFirmwareSyncTrapModeSet(openapiClientHandle_t *client_handle,
1861  OPEN_CONTROL_t mode);
1862 
1863 /*****************************************************************/
1877 open_error_t openapiUnitMgrStackFirmwareSyncAllowDowngradeModeGet(openapiClientHandle_t *client_handle,
1878  OPEN_CONTROL_t *mode);
1879 
1880 /*****************************************************************/
1894 open_error_t openapiUnitMgrStackFirmwareSyncAllowDowngradeModeSet(openapiClientHandle_t *client_handle,
1895  OPEN_CONTROL_t mode);
1896 
1897 /*****************************************************************/
1912 open_error_t openapiUnitMgrSampleModeSet(openapiClientHandle_t *client_handle,
1913  openUnitStatusSampleMode_t sampleMode,
1914  uint32_t sampleSize);
1915 
1916 /*****************************************************************/
1930 open_error_t openapiUnitMgrUnitStatusClear(openapiClientHandle_t *client_handle,
1931  uint32_t unit);
1932 
1933 /*****************************************************************/
1948 open_error_t openapiUnitMgrUnitStatusInfoGet(openapiClientHandle_t *client_handle,
1949  uint32_t unit,
1950  openUnitStatusUnitInfo_t *unit_info);
1951 
1952 /*****************************************************************/
1967 open_error_t openapiUnitMgrStackConfigReset(openapiClientHandle_t *client_handle,
1968  uint32_t unit);
1969 
1970 /*****************************************************************/
1986 open_error_t openapiUnitMgrDebianRootfsStatusGet(openapiClientHandle_t *client_handle,
1987  uint32_t unit,
1988  OPEN_UNIT_MGR_ROOTFS_STATUS_t *status);
1989 
1990 /*****************************************************************/
2007 open_error_t openapiUnitMgrEraseDhcpClientConfigFile(openapiClientHandle_t *client_handle,
2008  OPEN_BOOL_t all,
2009  open_buffdesc *fileName);
2010 
2011 /*****************************************************************/
2024 open_error_t openapiSpmStackPortCountersClear(openapiClientHandle_t *client_handle);
2025 
2026 /*****************************************************************/
2040 open_error_t openapiSpmIsPortStackCapable(openapiClientHandle_t *client_handle,
2041  uint32_t intIfNum, OPEN_BOOL_t *capable);
2042 
2043 /*****************************************************************/
2055 open_error_t openapiStackTrunkHashModeSet(openapiClientHandle_t *client_handle,
2056  uint32_t hashMode);
2057 
2058 /*****************************************************************/
2072 open_error_t openapiStackTrunkHashModeGet(openapiClientHandle_t *client_handle,
2073  uint32_t *hashMode);
2074 
2075 /*****************************************************************/
2088 open_error_t openapiStackIsTrunkHashModeConfigurable(openapiClientHandle_t *client_handle,
2089  uint32_t hashMode, OPEN_BOOL_t *valid);
2090 
2091 #endif /* OPENAPI_STACKING_H_INCLUDED */
2092 
OPEN_USMDB_UNITMGR_MGMTPREF_9
Preference 9.
Definition: openapi_stacking.h:76
openapiStmTemplateDescriptionGet
open_error_t openapiStmTemplateDescriptionGet(openapiClientHandle_t *client_handle, uint32_t templateId, open_buffdesc *templateDescr)
Gets description of specified template id.
OPEN_USMDB_UNITMGR_MGMTFUNC_UNASSIGNED
Preference 16.
Definition: openapi_stacking.h:83
OPEN_USMDB_UNITMGR_MGMT_FLAG_t
OPEN_USMDB_UNITMGR_MGMT_FLAG_t
Management Flag.
Definition: openapi_stacking.h:57
openapiSpmFpsStackingConfigSpeedGet
open_error_t openapiSpmFpsStackingConfigSpeedGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, uint32_t port, OPEN_STACK_SPEED_t *stackPortSpeed)
Get stacking speed configuration for a front-panel stack port.
openapiUnitMgrDebianRootfsStatusGet
open_error_t openapiUnitMgrDebianRootfsStatusGet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_UNIT_MGR_ROOTFS_STATUS_t *status)
Get the unit's stored Debian rootfs sync status.
openapiUnitMgrDebianRootfsOperVerSet
open_error_t openapiUnitMgrDebianRootfsOperVerSet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *version)
Given a unit, set the Debian Rootfs changes snapshot version currently in use.
openapiUnitMgrSupportedModelGet
open_error_t openapiUnitMgrSupportedModelGet(openapiClientHandle_t *client_handle, uint32_t unitTypeIdIndex, open_buffdesc *unitModel)
Get the supported unit model identifier for unit index.
openapiUnitMgrUnitNumberChange
open_error_t openapiUnitMgrUnitNumberChange(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t newUnitNumber)
Changes a unit's number.
openapiUnitMgrNsfSupportGet
open_error_t openapiUnitMgrNsfSupportGet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_BOOL_t *nsfSupport)
Get this unit's nonstop forwarding support.
openapiUnitMgrUnitMaxGet
open_error_t openapiUnitMgrUnitMaxGet(openapiClientHandle_t *client_handle, uint32_t *unit)
Gets the maximum stacking unit number (largest possible number of units in the stack).
openapiUnitMgrStackFirmwareSyncMemberStatusGet
open_error_t openapiUnitMgrStackFirmwareSyncMemberStatusGet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t *firmwareSyncStatus)
Get stack firmware synchronization status of member unit.
openapiSlotPowerModeGet
open_error_t openapiSlotPowerModeGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, OPEN_CONTROL_t *powerMode)
Given a unit and slot number, gets power mode of slot.
OPEN_STACK_SPEED_10G
10G stack speed
Definition: openapi_stacking.h:105
OPEN_SFS_SUCCESS
Success.
Definition: openapi_stacking.h:97
OPEN_STACK_SPEED_25G
25G stack speed
Definition: openapi_stacking.h:106
openapiUnitMgrSerialNumberGet
open_error_t openapiUnitMgrSerialNumberGet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *serialNumber)
Given a unit, gets the unit's serial number.
OPEN_USMDB_UNITMGR_MGMTPREF_t
OPEN_USMDB_UNITMGR_MGMTPREF_t
Unit's Management Preference.
Definition: openapi_stacking.h:65
openapiUnitMgrAdminMgmtPrefSet
open_error_t openapiUnitMgrAdminMgmtPrefSet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_USMDB_UNITMGR_MGMTPREF_t adminPref)
Set the admin management preference.
OPEN_UNIT_STATUS_SAMPLEMODE_MAX
Samplemode max.
Definition: openapi_stacking.h:124
openapiUnitMgrSupportedDescriptionGet
open_error_t openapiUnitMgrSupportedDescriptionGet(openapiClientHandle_t *client_handle, uint32_t unitTypeIndex, open_buffdesc *unitDescr)
Get unit description that corresponds to the index provided.
openapiUnitMgrStackFirmwareSyncStatusGet
open_error_t openapiUnitMgrStackFirmwareSyncStatusGet(openapiClientHandle_t *client_handle, OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t *firmwareSyncStatus)
Get stack firmware synchronization status.
openapiSpmFpsConfigQosModeSet
open_error_t openapiSpmFpsConfigQosModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t fpsQosMode)
Set QOS configuration for all front-panel stacking ports stack port.
openapiUnitMgrUnitTransfer
open_error_t openapiUnitMgrUnitTransfer(openapiClientHandle_t *client_handle, uint32_t targetUnit)
Transfers the management function from the current unit to another.
openapiUnitMgrStackConfigReset
open_error_t openapiUnitMgrStackConfigReset(openapiClientHandle_t *client_handle, uint32_t unit)
Reset stack config on a unit/stack.
openapiUnitMgrSupportedStmDefaultTemplateIdGet
open_error_t openapiUnitMgrSupportedStmDefaultTemplateIdGet(openapiClientHandle_t *client_handle, uint32_t unitTypeIdIndex, uint32_t *defaultTemplateId)
Get default template id for selected unit type index.
OPEN_SFS_LAST_ATTEMPT_STATUS_t
OPEN_SFS_LAST_ATTEMPT_STATUS_t
Stack Firmware Synchronization Last Attempt Status.
Definition: openapi_stacking.h:94
openapiSpmFpsConfigStackingModeSet
open_error_t openapiSpmFpsConfigStackingModeSet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, uint32_t port, OPEN_BOOL_t stackPortMode)
Set stacking mode configuration for a front-panel stack port.
OPEN_RUN_CFG_IN_PROGRESS
Running configuration on backup is the same as on mgmt unit.
Definition: openapi_stacking.h:134
openapiUnitMgrStackFirmwareSyncAllowDowngradeModeSet
open_error_t openapiUnitMgrStackFirmwareSyncAllowDowngradeModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Set stack firmware synchronization downgrade mode.
OPEN_RUN_CFG_STALE
Copy of running configuration is in progress.
Definition: openapi_stacking.h:132
openapiUnitMgrStartupReasonGet
open_error_t openapiUnitMgrStartupReasonGet(openapiClientHandle_t *client_handle, OPEN_LAST_STARTUP_REASON_t *reason)
Get the reason for the last restart.
openapiUnitMgrEraseFactoryDefaults
open_error_t openapiUnitMgrEraseFactoryDefaults(openapiClientHandle_t *client_handle)
Erase the factory-defaults file on other connected units.
open_revision_data_t
Definition: openapi_common.h:144
OPEN_UNITMGR_ROOTFS_OUT_OF_SYNC
Rootfs out of sync.
Definition: openapi_stacking.h:115
openapiUnitMgrStackMemberGetFirst
open_error_t openapiUnitMgrStackMemberGetFirst(openapiClientHandle_t *client_handle, uint32_t *firstUnit)
Get the first member of the current stack.
openapiUnitMgrUserDescriptionSet
open_error_t openapiUnitMgrUserDescriptionSet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *descr)
Set unit user description.
OPEN_STARTUP_POWER_ON
The switch re-booted.
Definition: openapi_stacking.h:145
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
openapiSlotSupportedPowerdownGet
open_error_t openapiSlotSupportedPowerdownGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, OPEN_BOOL_t *isPowerdown)
Given a unit and slot number, verify whether it powerdown indicator.
openapiUnitMgrStackFirmwareSyncMemberLastAttemptStatusGet
open_error_t openapiUnitMgrStackFirmwareSyncMemberLastAttemptStatusGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *lastAttemptStatus)
Get stack firmware synchronization last attempt status.
OPEN_UNITMGR_ROOTFS_SYNCED
Rootfs synced.
Definition: openapi_stacking.h:114
openapiUnitMgrSupportedUnitIdNextGet
open_error_t openapiUnitMgrSupportedUnitIdNextGet(openapiClientHandle_t *client_handle, uint32_t unitTypeIndex, uint32_t *nextUnitTypeIndex, uint32_t *unitType)
Get unit type identifier that corresponds to the next index.
openapiStackTrunkHashModeSet
open_error_t openapiStackTrunkHashModeSet(openapiClientHandle_t *client_handle, uint32_t hashMode)
Set hash mode configuration for all HG trunks.
openapiUnitMgrDetectCodeVerRunningGet
open_error_t openapiUnitMgrDetectCodeVerRunningGet(openapiClientHandle_t *client_handle, uint32_t unit, open_revision_data_t *codeVersion)
Given a unit, gets the unit's running version of code.
OPEN_USMDB_UNITMGR_CFG_MISMATCH
CFG Mismatch.
Definition: openapi_stacking.h:49
openapiCardTypeGet
open_error_t openapiCardTypeGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, uint32_t *cardIdConfig, uint32_t *cardIdInsert)
Given a unit and slot number, gets configured card type and inserted card type.
OPEN_RUN_CFG_CURRENT
No backup unit has been elected.
Definition: openapi_stacking.h:136
openapiUnitMgrRunCfgStatusString
open_error_t openapiUnitMgrRunCfgStatusString(openapiClientHandle_t *client_handle, OPEN_RUN_CFG_STATUS_t runCfgStatus, open_buffdesc *statusStr)
Convert a run config status to a string.
openUnitStatusSampleMode_t
openUnitStatusSampleMode_t
Definition: openapi_stacking.h:119
OPEN_USMDB_UNITMGR_MGMTPREF_2
Preference 2.
Definition: openapi_stacking.h:69
OPEN_LAST_STARTUP_REASON_t
OPEN_LAST_STARTUP_REASON_t
Definition: openapi_stacking.h:141
openapiUnitMgrUnitStatusInfoGet
open_error_t openapiUnitMgrUnitStatusInfoGet(openapiClientHandle_t *client_handle, uint32_t unit, openUnitStatusUnitInfo_t *unit_info)
Get the status information of specified unit.
OPEN_USMDB_UNITMGR_CODE_UPDATE
Code Update.
Definition: openapi_stacking.h:52
OPEN_USMDB_UNITMGR_MGMTPREF_3
Preference 3.
Definition: openapi_stacking.h:70
openapiSpmIsPortStackCapable
open_error_t openapiSpmIsPortStackCapable(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *capable)
To determine if a given port is stack capable.
open_buffdesc
Definition: openapi_common.h:138
OPEN_RUN_CFG_STATUS_t
OPEN_RUN_CFG_STATUS_t
Definition: openapi_stacking.h:127
openapiStackIsTrunkHashModeConfigurable
open_error_t openapiStackIsTrunkHashModeConfigurable(openapiClientHandle_t *client_handle, uint32_t hashMode, OPEN_BOOL_t *valid)
To check if the hash mode is configurable.
OPEN_SFS_SWITCH_STATUS_NO_ACTION
No Action.
Definition: openapi_stacking.h:89
openapiClientHandle_s
Definition: openapi_common.h:131
openapiUnitMgrDebianRootfsVerSet
open_error_t openapiUnitMgrDebianRootfsVerSet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *version)
Given a unit, set the Debian Rootfs changes snapshot version stored.
OPEN_STACK_SPEED_100G
100G stack speed
Definition: openapi_stacking.h:109
openapiSlotAdminModeGet
open_error_t openapiSlotAdminModeGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, OPEN_CONTROL_t *adminMode)
Given a unit and slot number, gets admin mode of slot.
openapiSpmFpsStackingConfigSpeedSet
open_error_t openapiSpmFpsStackingConfigSpeedSet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, uint32_t port, OPEN_STACK_SPEED_t stackPortSpeed)
Set stacking speed configuration for a front-panel stack port.
openapiSlotSupportedPluggableGet
open_error_t openapiSlotSupportedPluggableGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, OPEN_BOOL_t *isPluggable)
Given a unit and slot number, verify whether it has pluggable indicator.
OPEN_UNITMGR_ROOTFS_COPIED
Rootfs copied.
Definition: openapi_stacking.h:116
openapiUnitMgrDebianRootfsFileNameGet
open_error_t openapiUnitMgrDebianRootfsFileNameGet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *filename)
Get the Debian Rootfs changes snapshot file name.
openapiSlotIsFullGet
open_error_t openapiSlotIsFullGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, OPEN_BOOL_t *isFull)
Given a unit and slot number, verify whether the slot exists in the unit.
OPEN_USMDB_UNITMGR_MGMTPREF_12
Preference 12.
Definition: openapi_stacking.h:79
OPEN_USMDB_UNITMGR_MGMTPREF_11
Preference 11.
Definition: openapi_stacking.h:78
OPEN_UNIT_STATUS_SAMPLEMODE_CUMULATIVESUMMING
Samplemode cumulative summing.
Definition: openapi_stacking.h:122
openUnitStatusUnitInfo_s
Definition: openapi_stacking.h:185
openapiUnitMgrNsfAdminGet
open_error_t openapiUnitMgrNsfAdminGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *nsf)
Get the administrative status of nonstop forwarding.
OPEN_USMDB_UNITMGR_MGMTPREF_14
Preference 14.
Definition: openapi_stacking.h:81
openapiCardSupportedCardDescriptionGet
open_error_t openapiCardSupportedCardDescriptionGet(openapiClientHandle_t *client_handle, uint32_t cardId, open_buffdesc *bufd)
Given card index, gets card description.
openapiSlotGet
open_error_t openapiSlotGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, OPEN_BOOL_t *isValid)
Given a unit and slot number, verify whether the slot exists in the unit.
openapiSlotAdminModeSet
open_error_t openapiSlotAdminModeSet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, OPEN_CONTROL_t adminMode)
Given a unit, slot number and admin mode, configures it on device.
openapiUnitMgrStandbySet
open_error_t openapiUnitMgrStandbySet(openapiClientHandle_t *client_handle, uint32_t standbyUnit, OPEN_BOOL_t standbyAdminMode)
Sets the unit as standby in the stack.
openapiUnitMgrUnitTypeGet
open_error_t openapiUnitMgrUnitTypeGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *unitType, uint32_t *unitTypeIndex)
Given a unit, gets the unit's type and index.
OPEN_USMDB_UNITMGR_MGMTPREF_5
Preference 5.
Definition: openapi_stacking.h:72
openapiUnitMgrStackFirmwareSyncModeSet
open_error_t openapiUnitMgrStackFirmwareSyncModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Set stack firmware synchronication mode.
openapiFailoverInitiate
open_error_t openapiFailoverInitiate(openapiClientHandle_t *client_handle)
Initiate a warm failover to the backup unit.
openapiUnitMgrMgmtUnitStatusGet
open_error_t openapiUnitMgrMgmtUnitStatusGet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_USMDB_UNITMGR_MGMT_FLAG_t *mgmtStatus)
Given a unit, gets the unit's management status.
openapiUnitMgrUnitStatusGet
open_error_t openapiUnitMgrUnitStatusGet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_USMDB_UNITMGR_STATUS_t *status)
Given a unit, gets the unit's status.
OPEN_USMDB_UNITMGR_MGMT_UNASSIGNED
Unassigned.
Definition: openapi_stacking.h:61
OPEN_USMDB_UNITMGR_MGMTPREF_8
Preference 8.
Definition: openapi_stacking.h:75
openapiSpmFpsConfigQosModeGet
open_error_t openapiSpmFpsConfigQosModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *fpsQosMode)
Get QOS configuration for all front-panel stacking ports stack port.
OPEN_USMDB_UNITMGR_CODE_MISMATCH
Code Mismatch.
Definition: openapi_stacking.h:48
OPEN_USMDB_UNITMGR_MGMTPREF_13
Preference 13.
Definition: openapi_stacking.h:80
openapiUnitMgrPreconfigModelIdGet
open_error_t openapiUnitMgrPreconfigModelIdGet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *modelId)
Given a unit, gets the unit's model identifier string assigned by HPC(Hardware Platform Control) ...
openapiCdaTransferFile
open_error_t openapiCdaTransferFile(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *srcFileName, open_buffdesc *dstFileName)
Given a unit and filename, transfer file from current unit to the specified unit. ...
OPEN_SFS_NONE
None.
Definition: openapi_stacking.h:96
openapiUnitMgrServiceTagGet
open_error_t openapiUnitMgrServiceTagGet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *serviceTag)
Given a unit, gets the service tag.
openapiUnitMgrUnitStatusClear
open_error_t openapiUnitMgrUnitStatusClear(openapiClientHandle_t *client_handle, uint32_t unit)
Clear the sampling information of unit status.
openapiUnitMgrDebianRootfsVerGet
open_error_t openapiUnitMgrDebianRootfsVerGet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *version)
Given a unit, get the Debian Rootfs changes snapshot version stored.
openapiUnitMgrStandbyGet
open_error_t openapiUnitMgrStandbyGet(openapiClientHandle_t *client_handle, uint32_t *configUnit, uint32_t *standbyUnit, OPEN_BOOL_t *standbyAdminMode)
Gets the configured and standby unit number and admin mode in the stack.
OPEN_USMDB_UNITMGR_MGMTPREF_DISABLED
Disabled.
Definition: openapi_stacking.h:67
openapiUnitMgrEraseStartupConfig
open_error_t openapiUnitMgrEraseStartupConfig(openapiClientHandle_t *client_handle)
Erase the startup-config file on other connected units.
OPEN_USMDB_UNITMGR_UNIT_OK
Unit Ok.
Definition: openapi_stacking.h:46
OPEN_CONTROL_t
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
Definition: openapi_common.h:163
openapiUnitMgrModelIdentifierGet
open_error_t openapiUnitMgrModelIdentifierGet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *modelId, open_buffdesc *preconfigModelId)
Given a unit, gets the unit's model identifier string assigned by HPC and pre-configured model identi...
OPEN_SFS_MIN_BOOTCODE_VERSION_NOT_PRESENT
Min Bootcode Version Not Present.
Definition: openapi_stacking.h:99
openapiSlotPowerModeSet
open_error_t openapiSlotPowerModeSet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, OPEN_CONTROL_t powerMode)
Given a unit, slot number and power mode, configures it on device.
openapiCardSupportedCardModelIdGet
open_error_t openapiCardSupportedCardModelIdGet(openapiClientHandle_t *client_handle, uint32_t cardId, open_buffdesc *bufd)
Given card index, gets model Identifier.
openapiUnitMgrUnitIsValid
open_error_t openapiUnitMgrUnitIsValid(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_BOOL_t *isValid)
Given a unit, verify that it's within the valid range.
OPEN_BOOL_t
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
Definition: openapi_common.h:179
openapiUnitMgrStackFirmwareSyncTrapModeSet
open_error_t openapiUnitMgrStackFirmwareSyncTrapModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Set stack firmware synchronication trap mode.
openapiUnitMgrNsfAdminSet
open_error_t openapiUnitMgrNsfAdminSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t nsf)
Administratively enable or disable nonstop forwarding.
openapiUnitMgrSupportedLocalUnitIndexGet
open_error_t openapiUnitMgrSupportedLocalUnitIndexGet(openapiClientHandle_t *client_handle, uint32_t *unitTypeIdIndex)
Get the unit index of the local unit.
openapiStackTrunkHashModeGet
open_error_t openapiStackTrunkHashModeGet(openapiClientHandle_t *client_handle, uint32_t *hashMode)
Get the hash mode configuration for all HG trunks.
openapiUnitMgrDebianRootfsVersionFileNameGet
open_error_t openapiUnitMgrDebianRootfsVersionFileNameGet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *filename)
Get the Debian Rootfs changes snapshot version file name.
openUnitStatusInfo_s
Definition: openapi_stacking.h:174
OPEN_USMDB_UNITMGR_MGMTPREF_1
Preference 1.
Definition: openapi_stacking.h:68
openapiSpmStackPortCountersClear
open_error_t openapiSpmStackPortCountersClear(openapiClientHandle_t *client_handle)
Clear stack counters for all stack ports.
openapiStmUnitActiveTemplateIdGet
open_error_t openapiStmUnitActiveTemplateIdGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *templateId)
Gets active template id of the stack unit.
openapiUnitMgrStartupReasonStrGet
open_error_t openapiUnitMgrStartupReasonStrGet(openapiClientHandle_t *client_handle, OPEN_LAST_STARTUP_REASON_t reason, open_buffdesc *reasonStr)
Convert a startup reason to a string.
openapiUnitMgrUserDescriptionGet
open_error_t openapiUnitMgrUserDescriptionGet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *descr)
Get unit user description.
OPEN_STACK_SPEED_40G
40G stack speed
Definition: openapi_stacking.h:107
OPEN_STACK_SPEED_50G
50G stack speed
Definition: openapi_stacking.h:108
OPEN_STACK_SPEED_t
OPEN_STACK_SPEED_t
Definition: openapi_stacking.h:103
openapiUnitMgrUnitDelete
open_error_t openapiUnitMgrUnitDelete(openapiClientHandle_t *client_handle, uint32_t unit)
Remove a unit only if it is not an active member of the stack.
openapiUnitDbEntrySlotsGet
open_error_t openapiUnitDbEntrySlotsGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *count, open_buffdesc *bufd)
Given a unit number, it retrieves all slot information from the unit descriptor database.
openapiUnitMgrUnitIdKeyGet
open_error_t openapiUnitMgrUnitIdKeyGet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *key)
Get the unit system identifier key.
OPEN_SFS_FAIL
Fail.
Definition: openapi_stacking.h:98
OPEN_SFS_SWITCH_STATUS_IN_PROGRESS
In Progress.
Definition: openapi_stacking.h:90
OPEN_UNIT_MGR_ROOTFS_STATUS_t
OPEN_UNIT_MGR_ROOTFS_STATUS_t
Definition: openapi_stacking.h:112
openapixUnitMgrRunCfgStatusGet
open_error_t openapixUnitMgrRunCfgStatusGet(openapiClientHandle_t *client_handle, OPEN_RUN_CFG_STATUS_t *status)
Get the status of copying the running config to the backup unit.
openapiUnitMgrEraseDhcpClientConfigFile
open_error_t openapiUnitMgrEraseDhcpClientConfigFile(openapiClientHandle_t *client_handle, OPEN_BOOL_t all, open_buffdesc *fileName)
Erase the DHCP client configuration file on the stand-by unit.
openapiUnitMgrStackFirmwareSyncModeGet
open_error_t openapiUnitMgrStackFirmwareSyncModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
Get stack firmware synchronication mode.
openapiUnitMgrSampleModeSet
open_error_t openapiUnitMgrSampleModeSet(openapiClientHandle_t *client_handle, openUnitStatusSampleMode_t sampleMode, uint32_t sampleSize)
Set the mode of sample collection, size of sample.
OPEN_UNIT_STATUS_SAMPLEMODE_NONE
Samplemode none.
Definition: openapi_stacking.h:121
OPEN_STARTUP_AUTO_WARM
The system switched from the active manager to the backup manager and was unable to maintain nonstop ...
Definition: openapi_stacking.h:153
OPEN_RUN_CFG_NONE
Running configuration has not yet been copied to the backup unit.
Definition: openapi_stacking.h:130
openapiUnitMgrDebianRootfsOperVerGet
open_error_t openapiUnitMgrDebianRootfsOperVerGet(openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *version)
Given a unit, get the Debian Rootfs changes snapshot version currently in use.
OPEN_USMDB_UNITMGR_SDM_MISMATCH
SDM Mismatch.
Definition: openapi_stacking.h:50
openapiUnitMgrNextConfigCopyTime
open_error_t openapiUnitMgrNextConfigCopyTime(openapiClientHandle_t *client_handle, uint32_t *wait)
Get how long before the running config will next be copied to the backup unit, if a copy is scheduled...
openapiUnitMgrUnitUpTimeGet
open_error_t openapiUnitMgrUnitUpTimeGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *upTime)
Given a unit, gets the unit's up time in seconds.
openapiUnitMgrDetectCodeVerFlashGet
open_error_t openapiUnitMgrDetectCodeVerFlashGet(openapiClientHandle_t *client_handle, uint32_t unit, open_revision_data_t *codeVersion)
Given a unit, gets the unit's version of code in flash.
OPEN_USMDB_UNITMGR_MGMTPREF_4
Preference 4.
Definition: openapi_stacking.h:71
openapi_common.h
OPEN_UNIT_STATUS_SAMPLEMODE_HISTORY
Samplemode history.
Definition: openapi_stacking.h:123
OPEN_USMDB_UNITMGR_MGMT_ENABLED
Enabled.
Definition: openapi_stacking.h:59
openapiSpmFpsConfigStackingModeGet
open_error_t openapiSpmFpsConfigStackingModeGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, uint32_t port, OPEN_BOOL_t *stackPortMode)
Get stacking mode configuration for a front-panel stack port.
openapiUnitMgrUnitCreate
open_error_t openapiUnitMgrUnitCreate(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t unitTypeIndex, OPEN_BOOL_t synchMode)
Create a new unit record for unit.
OPEN_USMDB_UNITMGR_STM_MISMATCH
STM Mismatch.
Definition: openapi_stacking.h:53
openapiUnitMgrMgmtPrefGet
open_error_t openapiUnitMgrMgmtPrefGet(openapiClientHandle_t *client_handle, uint32_t unit, OPEN_USMDB_UNITMGR_MGMTPREF_t *hwPref, OPEN_USMDB_UNITMGR_MGMTPREF_t *adminPref)
Given a unit, gets the unit's hardware and admin management preference.
OPEN_STARTUP_COLD_ADMIN_MOVE
The administrator issued the "initiate failover" command for the stand-by manager to take over...
Definition: openapi_stacking.h:147
openapiUnitMgrSupportedUnitIdGet
open_error_t openapiUnitMgrSupportedUnitIdGet(openapiClientHandle_t *client_handle, uint32_t unitTypeIndex, uint32_t *unitType)
Get unit type identifier that corresponds to the index provided.
OPEN_USMDB_UNITMGR_MGMTPREF_10
Preference 10.
Definition: openapi_stacking.h:77
OPEN_USMDB_UNITMGR_UNIT_UNSUPPORTED
Unit Unsupported.
Definition: openapi_stacking.h:47
openapiUnitMgrStackFirmwareSyncAllowDowngradeModeGet
open_error_t openapiUnitMgrStackFirmwareSyncAllowDowngradeModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
Get stack firmware synchronization downgrade mode.
OPEN_USMDB_UNITMGR_MGMTPREF_7
Preference 7.
Definition: openapi_stacking.h:74
OPEN_USMDB_UNITMGR_MGMTPREF_15
Preference 15.
Definition: openapi_stacking.h:82
openapiUnitMgrStackFirmwareSyncTrapModeGet
open_error_t openapiUnitMgrStackFirmwareSyncTrapModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
Get stack firmware synchronication trap mode.
OPEN_STARTUP_WARM_ADMIN_MOVE
The primary management unit restarted because of a failure, and the system executed a nonstop forward...
Definition: openapi_stacking.h:150
OPEN_USMDB_UNITMGR_UNIT_NOT_PRESENT
Unit Not Present.
Definition: openapi_stacking.h:51
openapiUnitMgrResetUnit
open_error_t openapiUnitMgrResetUnit(openapiClientHandle_t *client_handle, uint32_t unit)
Given a unit, reboot the corresponding switch.
OPEN_USMDB_UNITMGR_STATUS_t
OPEN_USMDB_UNITMGR_STATUS_t
Stacking Unit Status.
Definition: openapi_stacking.h:44
OPEN_USMDB_UNITMGR_MGMT_DISABLED
Disabled.
Definition: openapi_stacking.h:60
openapiUnitMgrConfigAgeOnBackup
open_error_t openapiUnitMgrConfigAgeOnBackup(openapiClientHandle_t *client_handle, uint32_t *age)
Get the age of the configuration on the backup unit.
OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t
OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t
Stack Firmware Synchronization Status.
Definition: openapi_stacking.h:87
openapiSpmFpsStackingRunningSpeedGet
open_error_t openapiSpmFpsStackingRunningSpeedGet(openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, uint32_t port, OPEN_STACK_SPEED_t *stackPortSpeed)
Get stacking running speed configuration for a front-panel stack port.
openapiUnitMgrStackMemberGetNext
open_error_t openapiUnitMgrStackMemberGetNext(openapiClientHandle_t *client_handle, uint32_t startUnit, uint32_t *nextUnit)
Given a unit, gets the next member of the current stack.
openapiUnitMgrNumberGet
open_error_t openapiUnitMgrNumberGet(openapiClientHandle_t *client_handle, uint32_t *unit)
Get the manager's unit number.
OPEN_USMDB_UNITMGR_MGMTPREF_6
Preference 6.
Definition: openapi_stacking.h:73
openapiUnitMgrSupportedMgmtPrefGet
open_error_t openapiUnitMgrSupportedMgmtPrefGet(openapiClientHandle_t *client_handle, uint32_t unitTypeIdIndex, uint32_t *unitMgmtPref)
Get the management preference of the unit index.