Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
Stacking Configuration And Status [OPENAPI_STACKING]

Macros

#define OPEN_CDA_FILE_NAME_LENGTH   128
 
#define OPEN_UNITMGR_ROOTFS_SNAPSHOT_FILE   "/mnt/fastpath/upper1.tgz"
 
#define OPEN_UNITMGR_ROOTFS_SNAPSHOT_VER_FILE   "/mnt/fastpath/upper1.md5"
 
#define OPEN_UNITMGR_ROOTFS_VER_LENGTH   32
 
#define OPEN_UNITMGR_ROOTFS_VER_SIZE   33
 

Enumerations

enum  OPEN_SFS_LAST_ATTEMPT_STATUS_t { OPEN_SFS_NONE = 1, OPEN_SFS_SUCCESS = 2, OPEN_SFS_FAIL = 3, OPEN_SFS_MIN_BOOTCODE_VERSION_NOT_PRESENT = 4 }
 Stack Firmware Synchronization Last Attempt Status. More...
 
enum  OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t { OPEN_SFS_SWITCH_STATUS_NO_ACTION = 1, OPEN_SFS_SWITCH_STATUS_IN_PROGRESS = 2 }
 Stack Firmware Synchronization Status. More...
 
enum  OPEN_USMDB_UNITMGR_MGMT_FLAG_t { OPEN_USMDB_UNITMGR_MGMT_ENABLED = 1, OPEN_USMDB_UNITMGR_MGMT_DISABLED = 2, OPEN_USMDB_UNITMGR_MGMT_UNASSIGNED = 3 }
 Management Flag. More...
 
enum  OPEN_USMDB_UNITMGR_MGMTPREF_t {
  OPEN_USMDB_UNITMGR_MGMTPREF_DISABLED = 0, OPEN_USMDB_UNITMGR_MGMTPREF_1 = 1, OPEN_USMDB_UNITMGR_MGMTPREF_2 = 2, OPEN_USMDB_UNITMGR_MGMTPREF_3 = 3,
  OPEN_USMDB_UNITMGR_MGMTPREF_4 = 4, OPEN_USMDB_UNITMGR_MGMTPREF_5 = 5, OPEN_USMDB_UNITMGR_MGMTPREF_6 = 6, OPEN_USMDB_UNITMGR_MGMTPREF_7 = 7,
  OPEN_USMDB_UNITMGR_MGMTPREF_8 = 8, OPEN_USMDB_UNITMGR_MGMTPREF_9 = 9, OPEN_USMDB_UNITMGR_MGMTPREF_10 = 10, OPEN_USMDB_UNITMGR_MGMTPREF_11 = 11,
  OPEN_USMDB_UNITMGR_MGMTPREF_12 = 12, OPEN_USMDB_UNITMGR_MGMTPREF_13 = 13, OPEN_USMDB_UNITMGR_MGMTPREF_14 = 14, OPEN_USMDB_UNITMGR_MGMTPREF_15 = 15,
  OPEN_USMDB_UNITMGR_MGMTFUNC_UNASSIGNED = 16
}
 Unit's Management Preference. More...
 
enum  OPEN_USMDB_UNITMGR_STATUS_t {
  OPEN_USMDB_UNITMGR_UNIT_OK = 1, OPEN_USMDB_UNITMGR_UNIT_UNSUPPORTED = 2, OPEN_USMDB_UNITMGR_CODE_MISMATCH = 3, OPEN_USMDB_UNITMGR_CFG_MISMATCH = 4,
  OPEN_USMDB_UNITMGR_SDM_MISMATCH = 5, OPEN_USMDB_UNITMGR_UNIT_NOT_PRESENT = 6, OPEN_USMDB_UNITMGR_CODE_UPDATE = 7, OPEN_USMDB_UNITMGR_STM_MISMATCH = 8
}
 Stacking Unit Status. More...
 

Functions

open_error_t openapiCardSupportedCardDescriptionGet (openapiClientHandle_t *client_handle, uint32_t cardId, open_buffdesc *bufd)
 Given card index, gets card description. More...
 
open_error_t openapiCardSupportedCardModelIdGet (openapiClientHandle_t *client_handle, uint32_t cardId, open_buffdesc *bufd)
 Given card index, gets model Identifier. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
open_error_t openapiSpmFpsConfigQosModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *fpsQosMode)
 Get QOS configuration for all front-panel stacking ports stack port. More...
 
open_error_t openapiSpmFpsConfigQosModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t fpsQosMode)
 Set QOS configuration for all front-panel stacking ports stack port. More...
 
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. More...
 
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. More...
 
open_error_t openapiStmTemplateDescriptionGet (openapiClientHandle_t *client_handle, uint32_t templateId, open_buffdesc *templateDescr)
 Gets description of specified template id. More...
 
open_error_t openapiStmUnitActiveTemplateIdGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *templateId)
 Gets active template id of the stack unit. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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 identifier string. More...
 
open_error_t openapiUnitMgrNumberGet (openapiClientHandle_t *client_handle, uint32_t *unit)
 Get the manager's unit number. More...
 
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) More...
 
open_error_t openapiUnitMgrResetUnit (openapiClientHandle_t *client_handle, uint32_t unit)
 Given a unit, reboot the corresponding switch. More...
 
open_error_t openapiUnitMgrSerialNumberGet (openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *serialNumber)
 Given a unit, gets the unit's serial number. More...
 
open_error_t openapiUnitMgrServiceTagGet (openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *serviceTag)
 Given a unit, gets the service tag. More...
 
open_error_t openapiUnitMgrStackFirmwareSyncMemberLastAttemptStatusGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t *lastAttemptStatus)
 Get stack firmware synchronization last attempt status. More...
 
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. More...
 
open_error_t openapiUnitMgrStackFirmwareSyncStatusGet (openapiClientHandle_t *client_handle, OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t *firmwareSyncStatus)
 Get stack firmware synchronization status. More...
 
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. More...
 
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. More...
 
open_error_t openapiUnitMgrStandbySet (openapiClientHandle_t *client_handle, uint32_t standbyUnit, OPEN_BOOL_t standbyAdminMode)
 Sets the unit as standby in the stack. More...
 
open_error_t openapiUnitMgrSupportedDescriptionGet (openapiClientHandle_t *client_handle, uint32_t unitTypeIndex, open_buffdesc *unitDescr)
 Get unit description that corresponds to the index provided. More...
 
open_error_t openapiUnitMgrSupportedUnitIdGet (openapiClientHandle_t *client_handle, uint32_t unitTypeIndex, uint32_t *unitType)
 Get unit type identifier that corresponds to the index provided. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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). More...
 
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. More...
 
open_error_t openapiUnitMgrUnitTransfer (openapiClientHandle_t *client_handle, uint32_t targetUnit)
 Transfers the management function from the current unit to another. More...
 
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. More...
 
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. More...
 

Detailed Description

Enumeration Type Documentation

Stack Firmware Synchronization Last Attempt Status.

Enumerator
OPEN_SFS_NONE 

None.

OPEN_SFS_SUCCESS 

Success.

OPEN_SFS_FAIL 

Fail.

OPEN_SFS_MIN_BOOTCODE_VERSION_NOT_PRESENT 

Min Bootcode Version Not Present.

Definition at line 94 of file openapi_stacking.h.

Stack Firmware Synchronization Status.

Enumerator
OPEN_SFS_SWITCH_STATUS_NO_ACTION 

No Action.

OPEN_SFS_SWITCH_STATUS_IN_PROGRESS 

In Progress.

Definition at line 87 of file openapi_stacking.h.

Management Flag.

Enumerator
OPEN_USMDB_UNITMGR_MGMT_ENABLED 

Enabled.

OPEN_USMDB_UNITMGR_MGMT_DISABLED 

Disabled.

OPEN_USMDB_UNITMGR_MGMT_UNASSIGNED 

Unassigned.

Definition at line 57 of file openapi_stacking.h.

Unit's Management Preference.

Enumerator
OPEN_USMDB_UNITMGR_MGMTPREF_DISABLED 

Disabled.

OPEN_USMDB_UNITMGR_MGMTPREF_1 

Preference 1.

OPEN_USMDB_UNITMGR_MGMTPREF_2 

Preference 2.

OPEN_USMDB_UNITMGR_MGMTPREF_3 

Preference 3.

OPEN_USMDB_UNITMGR_MGMTPREF_4 

Preference 4.

OPEN_USMDB_UNITMGR_MGMTPREF_5 

Preference 5.

OPEN_USMDB_UNITMGR_MGMTPREF_6 

Preference 6.

OPEN_USMDB_UNITMGR_MGMTPREF_7 

Preference 7.

OPEN_USMDB_UNITMGR_MGMTPREF_8 

Preference 8.

OPEN_USMDB_UNITMGR_MGMTPREF_9 

Preference 9.

OPEN_USMDB_UNITMGR_MGMTPREF_10 

Preference 10.

OPEN_USMDB_UNITMGR_MGMTPREF_11 

Preference 11.

OPEN_USMDB_UNITMGR_MGMTPREF_12 

Preference 12.

OPEN_USMDB_UNITMGR_MGMTPREF_13 

Preference 13.

OPEN_USMDB_UNITMGR_MGMTPREF_14 

Preference 14.

OPEN_USMDB_UNITMGR_MGMTPREF_15 

Preference 15.

OPEN_USMDB_UNITMGR_MGMTFUNC_UNASSIGNED 

Preference 16.

Definition at line 65 of file openapi_stacking.h.

Stacking Unit Status.

Enumerator
OPEN_USMDB_UNITMGR_UNIT_OK 

Unit Ok.

OPEN_USMDB_UNITMGR_UNIT_UNSUPPORTED 

Unit Unsupported.

OPEN_USMDB_UNITMGR_CODE_MISMATCH 

Code Mismatch.

OPEN_USMDB_UNITMGR_CFG_MISMATCH 

CFG Mismatch.

OPEN_USMDB_UNITMGR_SDM_MISMATCH 

SDM Mismatch.

OPEN_USMDB_UNITMGR_UNIT_NOT_PRESENT 

Unit Not Present.

OPEN_USMDB_UNITMGR_CODE_UPDATE 

Code Update.

OPEN_USMDB_UNITMGR_STM_MISMATCH 

STM Mismatch.

Definition at line 44 of file openapi_stacking.h.

Function Documentation

open_error_t openapiCardSupportedCardDescriptionGet ( openapiClientHandle_t client_handle,
uint32_t  cardId,
open_buffdesc bufd 
)

Given card index, gets card description.

Parameters
[in]client_handleClient handle from registration API
[in]cardIdCard Index.
[out]bufdBuffer to store Card description
  • Buffer allocated size must be at least
  • OPENAPI_SYSAPI_HPC_CARD_DESCRIPTION_SIZE
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.10

Examples:
stacking_example.c.
open_error_t openapiCardSupportedCardModelIdGet ( openapiClientHandle_t client_handle,
uint32_t  cardId,
open_buffdesc bufd 
)

Given card index, gets model Identifier.

Parameters
[in]client_handleClient handle from registration API
[in]cardIdCard Index.
[out]bufdBuffer to store Card Model Id
  • Buffer allocated size must be at least
  • OPENAPI_SYSAPI_HPC_CARD_MODEL_SIZE
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit ID of the unit
-Maximum value openapiUnitMgrUnitMaxGet()
[in]slotSlot ID of the slot port
-Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT
[out]cardIdConfigConfigured card type
[out]cardIdInsertInserted card type
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitThe Unit ID of destination unit
-Maximum value openapiUnitMgrUnitMaxGet() Use OPENAPI_CDA_ALL_UNITS to transfer to all member units
[in]srcFileNameFilename to be transferred to destination unit
  • - Buffer allocated size must be at max
  • - OPENAPI_CDA_FILE_NAME_LENGTH
[in]dstFileNameFilename of transferred file on destination unit
  • Buffer allocated size must be at max
  • OPENAPI_CDA_FILE_NAME_LENGTH
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.19

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit ID of the unit
-Maximum value openapiUnitMgrUnitMaxGet()
[in]slotSlot ID of the slot port
-Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT
[out]adminModeConfigured Administrative mode
-Returns OPEN_ENABLE if adminMode is enabled else OPEN_DISABLE if not
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit ID of the unit
-Maximum value openapiUnitMgrUnitMaxGet()
[in]slotSlot ID of the slot port
-Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT
[in]adminModeConfigured Administrative mode
-Configures enabled if adminMode is OPEN_ENABLE
-Configures disabled if adminMode is OPEN_DISABLE
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
-Maximum value openapiUnitMgrUnitMaxGet()
[in]slotSlot ID of the slot port
-Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT
[out]isValidReturns OPEN_TRUE if slot number exists in the unit, else OPEN_FALSE if not
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit ID of the unit
-Maximum value openapiUnitMgrUnitMaxGet()
[in]slotSlot ID of the slot port
-Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT
[out]isFullReturns OPEN_TRUE if slot is full else OPEN_FALSE if not
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit ID of the unit
-Maximum value openapiUnitMgrUnitMaxGet()
[in]slotSlot ID of the slot port
-Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT
[out]powerModeConfigured Power mode
-Returns OPEN_ENABLE if powerMode is enabled else OPEN_DISABLE if not
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit ID of the unit
-Maximum value openapiUnitMgrUnitMaxGet()
[in]slotSlot ID of the slot port
-Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT
[in]powerModeConfigured power mode
-Configures enabled if powerMode is OPEN_ENABLE
-Configures disabled if powerMode is OPEN_DISABLE
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit ID of the unit
-Maximum value openapiUnitMgrUnitMaxGet()
[in]slotSlot ID of the slot port
-Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT
[out]isPluggableReturns OPEN_TRUE if card can be plugged into slot else OPEN_FALSE if not
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit ID of the unit
-Maximum value openapiUnitMgrUnitMaxGet()
[in]slotSlot ID of the slot port
-Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT
[out]isPowerdownReturns OPEN_TRUE if power down on slot else OPEN_FALSE if not
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.10

Examples:
stacking_example.c.
open_error_t openapiSpmFpsConfigQosModeGet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t fpsQosMode 
)

Get QOS configuration for all front-panel stacking ports stack port.

Parameters
[in]client_handleClient handle from registration API
[out]fpsQosModeReturns OPEN_ENABLE if QOS mode is enabled, else OPEN_DISABLE if not
Return values
OPEN_E_NONEif issued successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_UNAVAILif feature is not supported

OpEN API Version: 1.10

Examples:
stacking_example.c.
open_error_t openapiSpmFpsConfigQosModeSet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t  fpsQosMode 
)

Set QOS configuration for all front-panel stacking ports stack port.

Parameters
[in]client_handleClient handle from registration API
[in]fpsQosModeFront panel stacking QOS mode
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif set operation has failed
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_UNAVAILif feature is not supported

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]slotSlot
[in]portPort
[out]stackPortModeReturns OPEN_TRUE if admin mode is enabled, else OPEN_FALSE if not
Return values
OPEN_E_NONEif issued successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_UNAVAILif feature is not supported

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]slotSlot
[in]portPort
[in]stackPortModeEnable front-panel stacking mode
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif set operation has failed
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_UNAVAILif feature is not supported

OpEN API Version: 1.10

Examples:
stacking_example.c.
open_error_t openapiStmTemplateDescriptionGet ( openapiClientHandle_t client_handle,
uint32_t  templateId,
open_buffdesc templateDescr 
)

Gets description of specified template id.

Parameters
[in]client_handleClient handle from registration API
[in]templateIdTemplate id
[out]templateDescrTemplate description
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_UNAVAILif feature is not supported

OpEN API Version: 1.10

Examples:
stacking_example.c.
open_error_t openapiStmUnitActiveTemplateIdGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t *  templateId 
)

Gets active template id of the stack unit.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]templateIdTemplate id
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_UNAVAILif feature is not supported

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitunit type identifier
-Maximum value openapiUnitMgrUnitMaxGet()
[out]countThe number of slots in array
[out]bufdThe slots array. The size of each slot is uint32_t.
  • Buffer allocated size must be at least
  • OPENAPI_L7_MAX_PHYSICAL_SLOTS_PER_UNIT
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitThe Unit ID of destination unit
-Maximum value openapiUnitMgrUnitMaxGet()
[out]versionMD5 Checksum of changes snapshot
  • Buffer allocated size must be at least
  • OPENAPI_UNITMGR_ROOTFS_VER_SIZE
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.19

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.

Parameters
[in]client_handleClient handle from registration API
[in]unitThe Unit ID of destination unit
-Maximum value openapiUnitMgrUnitMaxGet()
[in]versionMD5 Checksum of changes snapshot
  • Buffer allocated size must be at least
  • OPENAPI_UNITMGR_ROOTFS_VER_SIZE
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.19

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.

Parameters
[in]client_handleClient handle from registration API
[in]unitThe Unit ID of destination unit
-Maximum value openapiUnitMgrUnitMaxGet()
[out]versionMD5 Checksum of changes snapshot
  • Buffer allocated size must be at least
  • OPENAPI_UNITMGR_ROOTFS_VER_SIZE
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.19

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.

Parameters
[in]client_handleClient handle from registration API
[in]unitThe Unit ID of destination unit
-Maximum value openapiUnitMgrUnitMaxGet()
[in]versionMD5 Checksum of changes snapshot
  • Buffer allocated size must be at least
  • OPENAPI_UNITMGR_ROOTFS_VER_SIZE
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.19

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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]codeVersionCode version
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]codeVersionCode version
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]hwPrefHardware preference
[out]adminPrefAdmin preference
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]mgmtStatusManagement status
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
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 identifier string.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]modelIdModel id
  • Buffer allocated size must be at least
  • OPENAPI_SYSAPI_HPC_UNIT_MODEL_SIZE
[out]preconfigModelIdPre-configured model id
  • Buffer allocated size must be at least
  • OPENAPI_SYSAPI_HPC_UNIT_MODEL_SIZE
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
open_error_t openapiUnitMgrNumberGet ( openapiClientHandle_t client_handle,
uint32_t *  unit 
)

Get the manager's unit number.

Parameters
[in]client_handleClient handle from registration API
[out]unitPointer to manager's unit number
Return values
OPEN_E_NONEif issued successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.8

Examples:
stacking_example.c.
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)

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]modelIdPointer to model id string storage
  • Buffer allocated size must be at least
  • OPENAPI_SYSAPI_HPC_UNIT_MODEL_SIZE
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.8

Examples:
stacking_example.c.
open_error_t openapiUnitMgrResetUnit ( openapiClientHandle_t client_handle,
uint32_t  unit 
)

Given a unit, reboot the corresponding switch.

Parameters
[in]client_handleClient handle from registration API
[in]unitThe Unit ID of destination unit
-Maximum value openapiUnitMgrUnitMaxGet()
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_NOT_FOUNDIf this slot is not configured
OPEN_E_FAILif get operation has failed

OpEN API Version: 1.19

open_error_t openapiUnitMgrSerialNumberGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
open_buffdesc serialNumber 
)

Given a unit, gets the unit's serial number.

Parameters
[in]client_handleClient handle from registration API
[in]unitunit number
[out]serialNumberPointer to unit's serial number
  • Buffer allocated size must be at least
  • OPENAPI_UNITMGR_SERIAL_NUMBER_SIZE
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.8

Examples:
stacking_example.c.
open_error_t openapiUnitMgrServiceTagGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
open_buffdesc serviceTag 
)

Given a unit, gets the service tag.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]serviceTagPointer to unit's service tag.
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.8

Examples:
stacking_example.c.
open_error_t openapiUnitMgrStackFirmwareSyncMemberLastAttemptStatusGet ( openapiClientHandle_t client_handle,
uint32_t  unit,
uint32_t *  lastAttemptStatus 
)

Get stack firmware synchronization last attempt status.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]lastAttemptStatusLast attempt status
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_UNAVAILif feature is not supported

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]firmwareSyncStatusFirmware synchronization status
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
open_error_t openapiUnitMgrStackFirmwareSyncStatusGet ( openapiClientHandle_t client_handle,
OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t firmwareSyncStatus 
)

Get stack firmware synchronization status.

Parameters
[in]client_handleClient handle from registration API
[out]firmwareSyncStatusFirmware synchronization status
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_UNAVAILif feature is not supported

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]startUnitInitial unit number
[out]nextUnitPointer to return next unit in stack
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.8

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[out]configUnitConfigured unit
[out]standbyUnitStandby unit
[out]standbyAdminModeReturns OPEN_TRUE if admin mode is enabled, else OPEN_FALSE if not
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
open_error_t openapiUnitMgrStandbySet ( openapiClientHandle_t client_handle,
uint32_t  standbyUnit,
OPEN_BOOL_t  standbyAdminMode 
)

Sets the unit as standby in the stack.

Parameters
[in]client_handleClient handle from registration API
[in]standbyUnitStandby unit
[in]standbyAdminModeStandby admin mode
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif set operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
open_error_t openapiUnitMgrSupportedDescriptionGet ( openapiClientHandle_t client_handle,
uint32_t  unitTypeIndex,
open_buffdesc unitDescr 
)

Get unit description that corresponds to the index provided.

Parameters
[in]client_handleClient handle from registration API
[in]unitTypeIndexUnit index
[out]unitDescrUnit description
  • Buffer allocated size must be at least
  • OPENAPI_SYSAPI_HPC_UNIT_DESCRIPTION_SIZE
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
open_error_t openapiUnitMgrSupportedUnitIdGet ( openapiClientHandle_t client_handle,
uint32_t  unitTypeIndex,
uint32_t *  unitType 
)

Get unit type identifier that corresponds to the index provided.

Parameters
[in]client_handleClient handle from registration API
[in]unitTypeIndexUnit type index
[out]unitTypeUnit type of hardware used to determine stacking compatibility
Return values
OPEN_E_NONEif issued successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitTypeIndexUnit type index
[out]nextUnitTypeIndexUnit type index
[out]unitTypeUnit type of hardware used to determine stacking compatibility
Return values
OPEN_E_NONEif issued successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[in]unitTypeIndexUnit type index
[in]synchModeSynchronous mode
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif create operation has failed
OPEN_E_PARAMif invalid parameter is supplied
Note
When it is set to 1, registrants within the switch are notified of card insertion(s) during the execution of the API call, otherwise they are notified afterwards (asynchronously).

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif delete operation has failed
OPEN_E_PARAMif invalid parameter is supplied
OPEN_E_ERRORif unit is an active member of the stack

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
-Minimum value 1
-Maximum value openapiUnitMgrUnitMaxGet()
[out]isValidReturns OPEN_TRUE if unit number is valid, else OPEN_FALSE if not
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.8

Examples:
stacking_example.c.
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).

Parameters
[in]client_handleClient handle from registration API
[out]unitUnit number
Return values
OPEN_E_NONEif successful
OPEN_E_PARAMif invalid parameter is supplied
Note
The default unit number is returned for non-stacking builds.

OpEN API Version: 1.8

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]statusUnit status
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
open_error_t openapiUnitMgrUnitTransfer ( openapiClientHandle_t client_handle,
uint32_t  targetUnit 
)

Transfers the management function from the current unit to another.

Parameters
[in]client_handleClient handle from registration API
[in]targetUnitTarget unit
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]unitTypeUnit type of hardware used to determine stacking compatibility
[out]unitTypeIndexUnit type index
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.
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.

Parameters
[in]client_handleClient handle from registration API
[in]unitUnit number
[out]upTimeUp time
Return values
OPEN_E_NONEif successful
OPEN_E_FAILif get operation has failed
OPEN_E_PARAMif invalid parameter is supplied

OpEN API Version: 1.10

Examples:
stacking_example.c.