Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
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... | |
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.
Definition at line 65 of file openapi_stacking.h.
Stacking Unit Status.
Definition at line 44 of file openapi_stacking.h.
open_error_t openapiCardSupportedCardDescriptionGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | cardId, | ||
open_buffdesc * | bufd | ||
) |
Given card index, gets card description.
[in] | client_handle | Client handle from registration API |
[in] | cardId | Card Index. |
[out] | bufd | Buffer to store Card description
|
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if get operation has failed |
OpEN API Version: 1.10
open_error_t openapiCardSupportedCardModelIdGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | cardId, | ||
open_buffdesc * | bufd | ||
) |
Given card index, gets model Identifier.
[in] | client_handle | Client handle from registration API |
[in] | cardId | Card Index. |
[out] | bufd | Buffer to store Card Model Id
|
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if get operation has failed |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit ID of the unit |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[in] | slot | Slot ID of the slot port |
- | Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT | |
[out] | cardIdConfig | Configured card type |
[out] | cardIdInsert | Inserted card type |
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if get operation has failed |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | The Unit ID of destination unit |
- | Maximum value openapiUnitMgrUnitMaxGet() Use OPENAPI_CDA_ALL_UNITS to transfer to all member units | |
[in] | srcFileName | Filename to be transferred to destination unit
|
[in] | dstFileName | Filename of transferred file on destination unit
|
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if get operation has failed |
OpEN API Version: 1.19
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit ID of the unit |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[in] | slot | Slot ID of the slot port |
- | Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT | |
[out] | adminMode | Configured Administrative mode |
- | Returns OPEN_ENABLE if adminMode is enabled else OPEN_DISABLE if not |
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if get operation has failed |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit ID of the unit |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[in] | slot | Slot ID of the slot port |
- | Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT | |
[in] | adminMode | Configured Administrative mode |
- | Configures enabled if adminMode is OPEN_ENABLE | |
- | Configures disabled if adminMode is OPEN_DISABLE |
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if get operation has failed |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[in] | slot | Slot ID of the slot port |
- | Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT | |
[out] | isValid | Returns OPEN_TRUE if slot number exists in the unit, else OPEN_FALSE if not |
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit ID of the unit |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[in] | slot | Slot ID of the slot port |
- | Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT | |
[out] | isFull | Returns OPEN_TRUE if slot is full else OPEN_FALSE if not |
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if get operation has failed |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit ID of the unit |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[in] | slot | Slot ID of the slot port |
- | Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT | |
[out] | powerMode | Configured Power mode |
- | Returns OPEN_ENABLE if powerMode is enabled else OPEN_DISABLE if not |
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if get operation has failed |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit ID of the unit |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[in] | slot | Slot ID of the slot port |
- | Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT | |
[in] | powerMode | Configured power mode |
- | Configures enabled if powerMode is OPEN_ENABLE | |
- | Configures disabled if powerMode is OPEN_DISABLE |
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if get operation has failed |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit ID of the unit |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[in] | slot | Slot ID of the slot port |
- | Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT | |
[out] | isPluggable | Returns OPEN_TRUE if card can be plugged into slot else OPEN_FALSE if not |
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if get operation has failed |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit ID of the unit |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[in] | slot | Slot ID of the slot port |
- | Maximum value OPENAPI_L7_MAX_SLOTS_PER_UNIT | |
[out] | isPowerdown | Returns OPEN_TRUE if power down on slot else OPEN_FALSE if not |
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if get operation has failed |
OpEN API Version: 1.10
open_error_t openapiSpmFpsConfigQosModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | fpsQosMode | ||
) |
Get QOS configuration for all front-panel stacking ports stack port.
[in] | client_handle | Client handle from registration API |
[out] | fpsQosMode | Returns OPEN_ENABLE if QOS mode is enabled, else OPEN_DISABLE if not |
OPEN_E_NONE | if issued successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_UNAVAIL | if feature is not supported |
OpEN API Version: 1.10
open_error_t openapiSpmFpsConfigQosModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | fpsQosMode | ||
) |
Set QOS configuration for all front-panel stacking ports stack port.
[in] | client_handle | Client handle from registration API |
[in] | fpsQosMode | Front panel stacking QOS mode |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if set operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_UNAVAIL | if feature is not supported |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | slot | Slot |
[in] | port | Port |
[out] | stackPortMode | Returns OPEN_TRUE if admin mode is enabled, else OPEN_FALSE if not |
OPEN_E_NONE | if issued successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_UNAVAIL | if feature is not supported |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | slot | Slot |
[in] | port | Port |
[in] | stackPortMode | Enable front-panel stacking mode |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if set operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_UNAVAIL | if feature is not supported |
OpEN API Version: 1.10
open_error_t openapiStmTemplateDescriptionGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | templateId, | ||
open_buffdesc * | templateDescr | ||
) |
Gets description of specified template id.
[in] | client_handle | Client handle from registration API |
[in] | templateId | Template id |
[out] | templateDescr | Template description |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_UNAVAIL | if feature is not supported |
OpEN API Version: 1.10
open_error_t openapiStmUnitActiveTemplateIdGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
uint32_t * | templateId | ||
) |
Gets active template id of the stack unit.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | templateId | Template id |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_UNAVAIL | if feature is not supported |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | unit type identifier |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[out] | count | The number of slots in array |
[out] | bufd | The slots array. The size of each slot is uint32_t.
|
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_FAIL | if get operation has failed |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | The Unit ID of destination unit |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[out] | version | MD5 Checksum of changes snapshot
|
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if 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.
[in] | client_handle | Client handle from registration API |
[in] | unit | The Unit ID of destination unit |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[in] | version | MD5 Checksum of changes snapshot
|
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if 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.
[in] | client_handle | Client handle from registration API |
[in] | unit | The Unit ID of destination unit |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[out] | version | MD5 Checksum of changes snapshot
|
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if 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.
[in] | client_handle | Client handle from registration API |
[in] | unit | The Unit ID of destination unit |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[in] | version | MD5 Checksum of changes snapshot
|
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if 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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | codeVersion | Code version |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | codeVersion | Code version |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | hwPref | Hardware preference |
[out] | adminPref | Admin preference |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | mgmtStatus | Management status |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | modelId | Model id
|
[out] | preconfigModelId | Pre-configured model id
|
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
open_error_t openapiUnitMgrNumberGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | unit | ||
) |
Get the manager's unit number.
[in] | client_handle | Client handle from registration API |
[out] | unit | Pointer to manager's unit number |
OPEN_E_NONE | if issued successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.8
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)
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | modelId | Pointer to model id string storage
|
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.8
open_error_t openapiUnitMgrResetUnit | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit | ||
) |
Given a unit, reboot the corresponding switch.
[in] | client_handle | Client handle from registration API |
[in] | unit | The Unit ID of destination unit |
- | Maximum value openapiUnitMgrUnitMaxGet() |
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_NOT_FOUND | If this slot is not configured |
OPEN_E_FAIL | if 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.
[in] | client_handle | Client handle from registration API |
[in] | unit | unit number |
[out] | serialNumber | Pointer to unit's serial number
|
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.8
open_error_t openapiUnitMgrServiceTagGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
open_buffdesc * | serviceTag | ||
) |
Given a unit, gets the service tag.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | serviceTag | Pointer to unit's service tag.
|
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.8
open_error_t openapiUnitMgrStackFirmwareSyncMemberLastAttemptStatusGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unit, | ||
uint32_t * | lastAttemptStatus | ||
) |
Get stack firmware synchronization last attempt status.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | lastAttemptStatus | Last attempt status |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_UNAVAIL | if feature is not supported |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | firmwareSyncStatus | Firmware synchronization status |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
open_error_t openapiUnitMgrStackFirmwareSyncStatusGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t * | firmwareSyncStatus | ||
) |
Get stack firmware synchronization status.
[in] | client_handle | Client handle from registration API |
[out] | firmwareSyncStatus | Firmware synchronization status |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_UNAVAIL | if feature is not supported |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | startUnit | Initial unit number |
[out] | nextUnit | Pointer to return next unit in stack |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[out] | configUnit | Configured unit |
[out] | standbyUnit | Standby unit |
[out] | standbyAdminMode | Returns OPEN_TRUE if admin mode is enabled, else OPEN_FALSE if not |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
open_error_t openapiUnitMgrStandbySet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | standbyUnit, | ||
OPEN_BOOL_t | standbyAdminMode | ||
) |
Sets the unit as standby in the stack.
[in] | client_handle | Client handle from registration API |
[in] | standbyUnit | Standby unit |
[in] | standbyAdminMode | Standby admin mode |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if set operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
open_error_t openapiUnitMgrSupportedDescriptionGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unitTypeIndex, | ||
open_buffdesc * | unitDescr | ||
) |
Get unit description that corresponds to the index provided.
[in] | client_handle | Client handle from registration API |
[in] | unitTypeIndex | Unit index |
[out] | unitDescr | Unit description
|
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
open_error_t openapiUnitMgrSupportedUnitIdGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | unitTypeIndex, | ||
uint32_t * | unitType | ||
) |
Get unit type identifier that corresponds to the index provided.
[in] | client_handle | Client handle from registration API |
[in] | unitTypeIndex | Unit type index |
[out] | unitType | Unit type of hardware used to determine stacking compatibility |
OPEN_E_NONE | if issued successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unitTypeIndex | Unit type index |
[out] | nextUnitTypeIndex | Unit type index |
[out] | unitType | Unit type of hardware used to determine stacking compatibility |
OPEN_E_NONE | if issued successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[in] | unitTypeIndex | Unit type index |
[in] | synchMode | Synchronous mode |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if create operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if delete operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OPEN_E_ERROR | if unit is an active member of the stack |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
- | Minimum value 1 | |
- | Maximum value openapiUnitMgrUnitMaxGet() | |
[out] | isValid | Returns OPEN_TRUE if unit number is valid, else OPEN_FALSE if not |
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.8
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).
[in] | client_handle | Client handle from registration API |
[out] | unit | Unit number |
OPEN_E_NONE | if successful |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.8
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | status | Unit status |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
open_error_t openapiUnitMgrUnitTransfer | ( | openapiClientHandle_t * | client_handle, |
uint32_t | targetUnit | ||
) |
Transfers the management function from the current unit to another.
[in] | client_handle | Client handle from registration API |
[in] | targetUnit | Target unit |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | unitType | Unit type of hardware used to determine stacking compatibility |
[out] | unitTypeIndex | Unit type index |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10
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.
[in] | client_handle | Client handle from registration API |
[in] | unit | Unit number |
[out] | upTime | Up time |
OPEN_E_NONE | if successful |
OPEN_E_FAIL | if get operation has failed |
OPEN_E_PARAM | if invalid parameter is supplied |
OpEN API Version: 1.10