Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
openapi_stacking.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

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...