Stacking Configuration And Status [OPENAPI_STACKING]

Data Structures
struct	openUnitStatusInfo_s
struct	openUnitStatusUnitInfo_s

Macros
#define	OPEN_ALL_UNITS   (OPEN_MAX_UNITS_PER_STACK + 1)
#define	OPEN_CDA_FILE_NAME_LENGTH   128
#define	OPEN_MAX_UNITS_PER_STACK   12
#define	OPEN_UNITMGR_LEGACY_ROOTFS_COMPAT_STRING   "1"
#define	OPEN_UNITMGR_ROOTFS_COMPAT_FILE   "/etc/bootstrap-distro-compat"
#define	OPEN_UNITMGR_ROOTFS_COMPAT_STRING_LENGTH   32
#define	OPEN_UNITMGR_ROOTFS_SNAPSHOT_FILE   "/mnt/fastpath/upper1.tgz"
#define	OPEN_UNITMGR_ROOTFS_SNAPSHOT_FILE_NAME_LENGTH   64
#define	OPEN_UNITMGR_ROOTFS_SNAPSHOT_VER_FILE   "/mnt/fastpath/upper1.md5"
#define	OPEN_UNITMGR_ROOTFS_SNAPSHOT_VERSION_FILE_NAME_LENGTH   64
#define	OPEN_UNITMGR_ROOTFS_VER_LENGTH   32
#define	OPEN_UNITMGR_ROOTFS_VER_SIZE   33

Typedefs
typedef struct openUnitStatusInfo_s	openUnitStatusInfo_t
typedef struct openUnitStatusUnitInfo_s	openUnitStatusUnitInfo_t

Enumerations
enum	OPEN_LAST_STARTUP_REASON_t {   OPEN_STARTUP_POWER_ON = 0, OPEN_STARTUP_COLD_ADMIN_MOVE, OPEN_STARTUP_WARM_ADMIN_MOVE, OPEN_STARTUP_AUTO_WARM,   OPEN_STARTUP_AUTO_COLD }
enum	OPEN_RUN_CFG_STATUS_t {   OPEN_RUN_CFG_NONE = 0, OPEN_RUN_CFG_STALE, OPEN_RUN_CFG_IN_PROGRESS, OPEN_RUN_CFG_CURRENT,   OPEN_RUN_CFG_NO_BACKUP }
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_STACK_SPEED_t {   OPEN_STACK_SPEED_10G = 0, OPEN_STACK_SPEED_25G, OPEN_STACK_SPEED_40G, OPEN_STACK_SPEED_50G,   OPEN_STACK_SPEED_100G }
enum	OPEN_UNIT_MGR_ROOTFS_STATUS_t { OPEN_UNITMGR_ROOTFS_SYNCED = 1, OPEN_UNITMGR_ROOTFS_OUT_OF_SYNC, OPEN_UNITMGR_ROOTFS_COPIED }
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...
enum	openUnitStatusSampleMode_t { OPEN_UNIT_STATUS_SAMPLEMODE_NONE, OPEN_UNIT_STATUS_SAMPLEMODE_CUMULATIVESUMMING, OPEN_UNIT_STATUS_SAMPLEMODE_HISTORY, OPEN_UNIT_STATUS_SAMPLEMODE_MAX }

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	openapiFailoverInitiate (openapiClientHandle_t *client_handle)
	Initiate a warm failover to the backup 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	openapiSpmFpsStackingConfigSpeedGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, uint32_t port, OPEN_STACK_SPEED_t *stackPortSpeed)
	Get stacking speed configuration for a front-panel stack port. More...
open_error_t	openapiSpmFpsStackingConfigSpeedSet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, uint32_t port, OPEN_STACK_SPEED_t stackPortSpeed)
	Set stacking speed configuration for a front-panel stack port. More...
open_error_t	openapiSpmFpsStackingRunningSpeedGet (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t slot, uint32_t port, OPEN_STACK_SPEED_t *stackPortSpeed)
	Get stacking running speed configuration for a front-panel stack port. More...
open_error_t	openapiSpmIsPortStackCapable (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *capable)
	To determine if a given port is stack capable. More...
open_error_t	openapiSpmStackPortCountersClear (openapiClientHandle_t *client_handle)
	Clear stack counters for all stack ports. More...
open_error_t	openapiStackIsTrunkHashModeConfigurable (openapiClientHandle_t *client_handle, uint32_t hashMode, OPEN_BOOL_t *valid)
	To check if the hash mode is configurable. More...
open_error_t	openapiStackTrunkHashModeGet (openapiClientHandle_t *client_handle, uint32_t *hashMode)
	Get the hash mode configuration for all HG trunks. More...
open_error_t	openapiStackTrunkHashModeSet (openapiClientHandle_t *client_handle, uint32_t hashMode)
	Set hash mode configuration for all HG trunks. 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	openapiUnitMgrAdminMgmtPrefSet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_USMDB_UNITMGR_MGMTPREF_t adminPref)
	Set the admin management preference. More...
open_error_t	openapiUnitMgrConfigAgeOnBackup (openapiClientHandle_t *client_handle, uint32_t *age)
	Get the age of the configuration on the backup unit. More...
open_error_t	openapiUnitMgrDebianRootfsFileNameGet (openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *filename)
	Get the Debian Rootfs changes snapshot file name. 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	openapiUnitMgrDebianRootfsStatusGet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_UNIT_MGR_ROOTFS_STATUS_t *status)
	Get the unit's stored Debian rootfs sync status. 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	openapiUnitMgrDebianRootfsVersionFileNameGet (openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *filename)
	Get the Debian Rootfs changes snapshot version file name. 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	openapiUnitMgrEraseDhcpClientConfigFile (openapiClientHandle_t *client_handle, OPEN_BOOL_t all, open_buffdesc *fileName)
	Erase the DHCP client configuration file on the stand-by unit. More...
open_error_t	openapiUnitMgrEraseFactoryDefaults (openapiClientHandle_t *client_handle)
	Erase the factory-defaults file on other connected units. More...
open_error_t	openapiUnitMgrEraseStartupConfig (openapiClientHandle_t *client_handle)
	Erase the startup-config file on other connected units. 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	openapiUnitMgrNextConfigCopyTime (openapiClientHandle_t *client_handle, uint32_t *wait)
	Get how long before the running config will next be copied to the backup unit, if a copy is scheduled. More...
open_error_t	openapiUnitMgrNsfAdminGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *nsf)
	Get the administrative status of nonstop forwarding. More...
open_error_t	openapiUnitMgrNsfAdminSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t nsf)
	Administratively enable or disable nonstop forwarding. More...
open_error_t	openapiUnitMgrNsfSupportGet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_BOOL_t *nsfSupport)
	Get this unit's nonstop forwarding support. 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	openapiUnitMgrRunCfgStatusString (openapiClientHandle_t *client_handle, OPEN_RUN_CFG_STATUS_t runCfgStatus, open_buffdesc *statusStr)
	Convert a run config status to a string. More...
open_error_t	openapiUnitMgrSampleModeSet (openapiClientHandle_t *client_handle, openUnitStatusSampleMode_t sampleMode, uint32_t sampleSize)
	Set the mode of sample collection, size of sample. 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	openapiUnitMgrStackConfigReset (openapiClientHandle_t *client_handle, uint32_t unit)
	Reset stack config on a unit/stack. More...
open_error_t	openapiUnitMgrStackFirmwareSyncAllowDowngradeModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
	Get stack firmware synchronization downgrade mode. More...
open_error_t	openapiUnitMgrStackFirmwareSyncAllowDowngradeModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Set stack firmware synchronization downgrade mode. 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	openapiUnitMgrStackFirmwareSyncModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
	Get stack firmware synchronication mode. More...
open_error_t	openapiUnitMgrStackFirmwareSyncModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Set stack firmware synchronication mode. 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	openapiUnitMgrStackFirmwareSyncTrapModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
	Get stack firmware synchronication trap mode. More...
open_error_t	openapiUnitMgrStackFirmwareSyncTrapModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Set stack firmware synchronication trap mode. More...
open_error_t	openapiUnitMgrStackMemberGetFirst (openapiClientHandle_t *client_handle, uint32_t *firstUnit)
	Get the first member of the current stack. 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	openapiUnitMgrStartupReasonGet (openapiClientHandle_t *client_handle, OPEN_LAST_STARTUP_REASON_t *reason)
	Get the reason for the last restart. More...
open_error_t	openapiUnitMgrStartupReasonStrGet (openapiClientHandle_t *client_handle, OPEN_LAST_STARTUP_REASON_t reason, open_buffdesc *reasonStr)
	Convert a startup reason to a string. 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	openapiUnitMgrSupportedLocalUnitIndexGet (openapiClientHandle_t *client_handle, uint32_t *unitTypeIdIndex)
	Get the unit index of the local unit. More...
open_error_t	openapiUnitMgrSupportedMgmtPrefGet (openapiClientHandle_t *client_handle, uint32_t unitTypeIdIndex, uint32_t *unitMgmtPref)
	Get the management preference of the unit index. More...
open_error_t	openapiUnitMgrSupportedModelGet (openapiClientHandle_t *client_handle, uint32_t unitTypeIdIndex, open_buffdesc *unitModel)
	Get the supported unit model identifier for unit index. More...
open_error_t	openapiUnitMgrSupportedStmDefaultTemplateIdGet (openapiClientHandle_t *client_handle, uint32_t unitTypeIdIndex, uint32_t *defaultTemplateId)
	Get default template id for selected unit type index. 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	openapiUnitMgrUnitIdKeyGet (openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *key)
	Get the unit system identifier key. 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	openapiUnitMgrUnitNumberChange (openapiClientHandle_t *client_handle, uint32_t unit, uint32_t newUnitNumber)
	Changes a unit's number. More...
open_error_t	openapiUnitMgrUnitStatusClear (openapiClientHandle_t *client_handle, uint32_t unit)
	Clear the sampling information of unit status. 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	openapiUnitMgrUnitStatusInfoGet (openapiClientHandle_t *client_handle, uint32_t unit, openUnitStatusUnitInfo_t *unit_info)
	Get the status information of specified unit. 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...
open_error_t	openapiUnitMgrUserDescriptionGet (openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *descr)
	Get unit user description. More...
open_error_t	openapiUnitMgrUserDescriptionSet (openapiClientHandle_t *client_handle, uint32_t unit, open_buffdesc *descr)
	Set unit user description. More...
open_error_t	openapixUnitMgrRunCfgStatusGet (openapiClientHandle_t *client_handle, OPEN_RUN_CFG_STATUS_t *status)
	Get the status of copying the running config to the backup unit. More...

Detailed Description

Enumeration Type Documentation

enum OPEN_LAST_STARTUP_REASON_t

Enumerator
OPEN_STARTUP_POWER_ON	The switch re-booted. This could have been caused by a power cycle or an administrative "Reload" command. The administrator issued the "move-management" command
OPEN_STARTUP_COLD_ADMIN_MOVE	The administrator issued the "initiate failover" command for the stand-by manager to take over.
OPEN_STARTUP_WARM_ADMIN_MOVE	The primary management unit restarted because of a failure, and the system executed a nonstop forwarding failover.
OPEN_STARTUP_AUTO_WARM	The system switched from the active manager to the backup manager and was unable to maintain nonstop forwarding. This is usually caused by multiple failures occurring close together or because NSF is operationally disabled.

Definition at line 141 of file openapi_stacking.h.

enum OPEN_RUN_CFG_STATUS_t

Enumerator
OPEN_RUN_CFG_NONE	Running configuration has not yet been copied to the backup unit. Running configuration has been copied, but it is out of date
OPEN_RUN_CFG_STALE	Copy of running configuration is in progress.
OPEN_RUN_CFG_IN_PROGRESS	Running configuration on backup is the same as on mgmt unit.
OPEN_RUN_CFG_CURRENT	No backup unit has been elected.

Definition at line 127 of file openapi_stacking.h.

enum OPEN_SFS_LAST_ATTEMPT_STATUS_t

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.

enum OPEN_STACK_SPEED_t

Enumerator
OPEN_STACK_SPEED_10G	10G stack speed
OPEN_STACK_SPEED_25G	25G stack speed
OPEN_STACK_SPEED_40G	40G stack speed
OPEN_STACK_SPEED_50G	50G stack speed
OPEN_STACK_SPEED_100G	100G stack speed

Definition at line 103 of file openapi_stacking.h.

enum OPEN_UNIT_MGR_ROOTFS_STATUS_t

Enumerator
OPEN_UNITMGR_ROOTFS_SYNCED	Rootfs synced.
OPEN_UNITMGR_ROOTFS_OUT_OF_SYNC	Rootfs out of sync.
OPEN_UNITMGR_ROOTFS_COPIED	Rootfs copied.

Definition at line 112 of file openapi_stacking.h.

enum OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t

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.

enum OPEN_USMDB_UNITMGR_MGMT_FLAG_t

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.

enum OPEN_USMDB_UNITMGR_MGMTPREF_t

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.

enum OPEN_USMDB_UNITMGR_STATUS_t

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.

enum openUnitStatusSampleMode_t

Enumerator
OPEN_UNIT_STATUS_SAMPLEMODE_NONE	Samplemode none.
OPEN_UNIT_STATUS_SAMPLEMODE_CUMULATIVESUMMING	Samplemode cumulative summing.
OPEN_UNIT_STATUS_SAMPLEMODE_HISTORY	Samplemode history.
OPEN_UNIT_STATUS_SAMPLEMODE_MAX	Samplemode max.

Definition at line 119 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_handle	Client handle from registration API
[in]	cardId	Card Index.
[out]	bufd	Buffer to store Card description Buffer allocated size must be at least OPENAPI_SYSAPI_HPC_CARD_DESCRIPTION_SIZE

Return values

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

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_handle	Client handle from registration API
[in]	cardId	Card Index.
[out]	bufd	Buffer to store Card Model Id Buffer allocated size must be at least OPENAPI_SYSAPI_HPC_CARD_MODEL_SIZE

Return values

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

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

Return values

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

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_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 - Buffer allocated size must be at max - OPENAPI_CDA_FILE_NAME_LENGTH
[in]	dstFileName	Filename of transferred file on destination unit Buffer allocated size must be at max OPENAPI_CDA_FILE_NAME_LENGTH

Return values

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

Examples:

stacking_example.c.

open_error_t openapiFailoverInitiate

(

openapiClientHandle_t *

client_handle

)

Initiate a warm failover to the backup unit.

Parameters

[in]

client_handle

client handle from registration API

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

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

Return values

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

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

Return values

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

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

Return values

OPEN_E_NONE	if successful
OPEN_E_PARAM	if 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_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

Return values

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

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

Return values

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

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

Return values

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

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

Return values

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

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

Return values

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

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_handle	Client handle from registration API
[out]	fpsQosMode	Returns OPEN_ENABLE if QOS mode is enabled, else OPEN_DISABLE if not

Return values

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

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_handle	Client handle from registration API
[in]	fpsQosMode	Front panel stacking QOS mode

Return values

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

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

Return values

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

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_handle	Client handle from registration API
[in]	unit	Unit number
[in]	slot	Slot
[in]	port	Port
[in]	stackPortMode	Enable front-panel stacking mode

Return values

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

Examples:

stacking_example.c.

open_error_t openapiSpmFpsStackingConfigSpeedGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		uint32_t	slot,
		uint32_t	port,
		OPEN_STACK_SPEED_t *	stackPortSpeed
	)

Get stacking speed configuration for a front-panel stack port.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	unit	Unit number.
[in]	slot	Slot.
[in]	port	Port.
[out]	stackPortSpeed	Stack port speed.

Return values

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

Examples:

stacking_example.c.

open_error_t openapiSpmFpsStackingConfigSpeedSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		uint32_t	slot,
		uint32_t	port,
		OPEN_STACK_SPEED_t	stackPortSpeed
	)

Set stacking speed configuration for a front-panel stack port.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	unit	Unit number.
[in]	slot	Slot.
[in]	port	Port.
[in]	stackPortSpeed	Stack port speed.

Return values

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

Examples:

stacking_example.c.

open_error_t openapiSpmFpsStackingRunningSpeedGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		uint32_t	slot,
		uint32_t	port,
		OPEN_STACK_SPEED_t *	stackPortSpeed
	)

Get stacking running speed configuration for a front-panel stack port.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	unit	Unit number.
[in]	slot	Slot.
[in]	port	Port.
[out]	stackPortSpeed	Operational stack port speed.

Return values

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

Examples:

stacking_example.c.

open_error_t openapiSpmIsPortStackCapable	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t *	capable
	)

To determine if a given port is stack capable.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	capable	capable or not

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiSpmStackPortCountersClear

(

openapiClientHandle_t *

client_handle

)

Clear stack counters for all stack ports.

Parameters

[in]

client_handle

client handle from registration API

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiStackIsTrunkHashModeConfigurable	(	openapiClientHandle_t *	client_handle,
		uint32_t	hashMode,
		OPEN_BOOL_t *	valid
	)

To check if the hash mode is configurable.

Parameters

[in]	client_handle	client handle from registration API
[in]	hashMode	hashing mode(1 to 10)
[out]	valid	valid or not

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiStackTrunkHashModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	hashMode
	)

Get the hash mode configuration for all HG trunks.

Parameters

[in]	client_handle	client handle from registration API
[out]	hashMode	hashing mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiStackTrunkHashModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	hashMode
	)

Set hash mode configuration for all HG trunks.

Parameters

[in]	client_handle	client handle from registration API
[in]	hashMode	hashing mode(1 to 10)

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.27

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_handle	Client handle from registration API
[in]	templateId	Template id
[out]	templateDescr	Template description

Return values

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

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_handle	Client handle from registration API
[in]	unit	Unit number
[out]	templateId	Template id

Return values

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

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_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. Buffer allocated size must be at least OPENAPI_L7_MAX_PHYSICAL_SLOTS_PER_UNIT

Return values

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

Examples:

stacking_example.c.

open_error_t openapiUnitMgrAdminMgmtPrefSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		OPEN_USMDB_UNITMGR_MGMTPREF_t	adminPref
	)

Set the admin management preference.

Parameters

[in]	client_handle	client handle from registration API
[in]	unit	unit number
[in]	adminPref	admin preference

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrConfigAgeOnBackup	(	openapiClientHandle_t *	client_handle,
		uint32_t *	age
	)

Get the age of the configuration on the backup unit.

Parameters

[in]	client_handle	client handle from registration API
[out]	age	age

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrDebianRootfsFileNameGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		open_buffdesc *	filename
	)

Get the Debian Rootfs changes snapshot file name.

Parameters

[in]	client_handle	Client handle from registration API
[in]	unit	The Unit ID of destination unit Maximum value openapiUnitMgrUnitMaxGet()
[out]	filename	File name of the rootfs changes snapshot Buffer allocated size must be at least OPEN_UNITMGR_ROOTFS_SNAPSHOT_FILE_NAME_LENGTH

Return values

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

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_handle	Client handle from registration API
[in]	unit	The Unit ID of destination unit
	-	Maximum value openapiUnitMgrUnitMaxGet()
[out]	version	MD5 Checksum of changes snapshot Buffer allocated size must be at least OPENAPI_UNITMGR_ROOTFS_VER_SIZE

Return values

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.

Parameters

[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 Buffer allocated size must be at least OPENAPI_UNITMGR_ROOTFS_VER_SIZE

Return values

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 openapiUnitMgrDebianRootfsStatusGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		OPEN_UNIT_MGR_ROOTFS_STATUS_t *	status
	)

Get the unit's stored Debian rootfs sync status.

Parameters

[in]	client_handle	client handle from registration API
[in]	unit	unit number
[out]	status	rootfs sync status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

Examples:

stacking_example.c.

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_handle	Client handle from registration API
[in]	unit	The Unit ID of destination unit
	-	Maximum value openapiUnitMgrUnitMaxGet()
[out]	version	MD5 Checksum of changes snapshot Buffer allocated size must be at least OPENAPI_UNITMGR_ROOTFS_VER_SIZE

Return values

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.

Parameters

[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 Buffer allocated size must be at least OPENAPI_UNITMGR_ROOTFS_VER_SIZE

Return values

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 openapiUnitMgrDebianRootfsVersionFileNameGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		open_buffdesc *	filename
	)

Get the Debian Rootfs changes snapshot version file name.

Parameters

[in]	client_handle	Client handle from registration API
[in]	unit	The Unit ID of destination unit Maximum value openapiUnitMgrUnitMaxGet()
[out]	filename	File name of the rootfs changes snapshot version Buffer allocated size must be at least OPEN_UNITMGR_ROOTFS_SNAPSHOT_FILE_VERSION_NAME_LENGTH

Return values

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.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_handle	Client handle from registration API
[in]	unit	Unit number
[out]	codeVersion	Code version

Return values

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

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_handle	Client handle from registration API
[in]	unit	Unit number
[out]	codeVersion	Code version

Return values

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

Examples:

stacking_example.c.

open_error_t openapiUnitMgrEraseDhcpClientConfigFile	(	openapiClientHandle_t *	client_handle,
		OPEN_BOOL_t	all,
		open_buffdesc *	fileName
	)

Erase the DHCP client configuration file on the stand-by unit.

Parameters

[in]	client_handle	client handle from registration API
[in]	all	all files or specific file
[in]	fileName	file to be deleted. When all files needs to be deleted then pass the directory path as fileName

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrEraseFactoryDefaults

(

openapiClientHandle_t *

client_handle

)

Erase the factory-defaults file on other connected units.

Parameters

[in]

client_handle

client handle from registration API

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrEraseStartupConfig

(

openapiClientHandle_t *

client_handle

)

Erase the startup-config file on other connected units.

Parameters

[in]

client_handle

client handle from registration API

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

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_handle	Client handle from registration API
[in]	unit	Unit number
[out]	hwPref	Hardware preference
[out]	adminPref	Admin preference

Return values

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

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_handle	Client handle from registration API
[in]	unit	Unit number
[out]	mgmtStatus	Management status

Return values

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

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_handle	Client handle from registration API
[in]	unit	Unit number
[out]	modelId	Model id Buffer allocated size must be at least OPENAPI_SYSAPI_HPC_UNIT_MODEL_SIZE
[out]	preconfigModelId	Pre-configured model id Buffer allocated size must be at least OPENAPI_SYSAPI_HPC_UNIT_MODEL_SIZE

Return values

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

Examples:

stacking_example.c.

open_error_t openapiUnitMgrNextConfigCopyTime	(	openapiClientHandle_t *	client_handle,
		uint32_t *	wait
	)

Get how long before the running config will next be copied to the backup unit, if a copy is scheduled.

Parameters

[in]	client_handle	client handle from registration API
[out]	wait	Number of seconds until config will be copied

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrNsfAdminGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	nsf
	)

Get the administrative status of nonstop forwarding.

Parameters

[in]	client_handle	client handle from registration API
[out]	nsf	enabled or disabled

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrNsfAdminSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	nsf
	)

Administratively enable or disable nonstop forwarding.

Parameters

[in]	client_handle	client handle from registration API
[in]	nsf	enable or disable

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrNsfSupportGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		OPEN_BOOL_t *	nsfSupport
	)

Get this unit's nonstop forwarding support.

Parameters

[in]	client_handle	client handle from registration API
[in]	unit	unit number
[out]	nsfSupport	nsf support

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrNumberGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	unit
	)

Get the manager's unit number.

Parameters

[in]	client_handle	Client handle from registration API
[out]	unit	Pointer to manager's unit number

Return values

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

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_handle	Client handle from registration API
[in]	unit	Unit number
[out]	modelId	Pointer to model id string storage Buffer allocated size must be at least OPENAPI_SYSAPI_HPC_UNIT_MODEL_SIZE

Return values

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

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_handle	Client handle from registration API
[in]	unit	The Unit ID of destination unit
	-	Maximum value openapiUnitMgrUnitMaxGet()

Return values

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 openapiUnitMgrRunCfgStatusString	(	openapiClientHandle_t *	client_handle,
		OPEN_RUN_CFG_STATUS_t	runCfgStatus,
		open_buffdesc *	statusStr
	)

Convert a run config status to a string.

Parameters

[in]	client_handle	client handle from registration API
[in]	runCfgStatus	status
[out]	statusStr	status string

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrSampleModeSet	(	openapiClientHandle_t *	client_handle,
		openUnitStatusSampleMode_t	sampleMode,
		uint32_t	sampleSize
	)

Set the mode of sample collection, size of sample.

Parameters

[in]	client_handle	client handle from registration API
[in]	sampleMode	Mode of sampling
[in]	sampleSize	Number of samples

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

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_handle	Client handle from registration API
[in]	unit	unit number
[out]	serialNumber	Pointer to unit's serial number Buffer allocated size must be at least OPENAPI_UNITMGR_SERIAL_NUMBER_SIZE

Return values

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

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_handle	Client handle from registration API
[in]	unit	Unit number
[out]	serviceTag	Pointer to unit's service tag. Buffer allocated size must be at least OPENAPI_SYSMGMT_SERVICE_TAG_MAX_LENGTH

Return values

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

Examples:

stacking_example.c.

open_error_t openapiUnitMgrStackConfigReset	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit
	)

Reset stack config on a unit/stack.

Parameters

[in]	client_handle	client handle from registration API
[in]	unit	unit number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrStackFirmwareSyncAllowDowngradeModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	mode
	)

Get stack firmware synchronization downgrade mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrStackFirmwareSyncAllowDowngradeModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Set stack firmware synchronization downgrade mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

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_handle	Client handle from registration API
[in]	unit	Unit number
[out]	lastAttemptStatus	Last attempt status

Return values

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

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_handle	Client handle from registration API
[in]	unit	Unit number
[out]	firmwareSyncStatus	Firmware synchronization status

Return values

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

Examples:

stacking_example.c.

open_error_t openapiUnitMgrStackFirmwareSyncModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	mode
	)

Get stack firmware synchronication mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrStackFirmwareSyncModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Set stack firmware synchronication mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

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_handle	Client handle from registration API
[out]	firmwareSyncStatus	Firmware synchronization status

Return values

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

Examples:

stacking_example.c.

open_error_t openapiUnitMgrStackFirmwareSyncTrapModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	mode
	)

Get stack firmware synchronication trap mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

open_error_t openapiUnitMgrStackFirmwareSyncTrapModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Set stack firmware synchronication trap mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrStackMemberGetFirst	(	openapiClientHandle_t *	client_handle,
		uint32_t *	firstUnit
	)

Get the first member of the current stack.

Parameters

[in]	client_handle	client handle from registration API
[out]	firstUnit	first unit number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

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_handle	Client handle from registration API
[in]	startUnit	Initial unit number
[out]	nextUnit	Pointer to return next unit in stack

Return values

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

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

Return values

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

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_handle	Client handle from registration API
[in]	standbyUnit	Standby unit
[in]	standbyAdminMode	Standby admin mode

Return values

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

Examples:

stacking_example.c.

open_error_t openapiUnitMgrStartupReasonGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LAST_STARTUP_REASON_t *	reason
	)

Get the reason for the last restart.

Parameters

[in]	client_handle	client handle from registration API
[out]	reason	reason

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrStartupReasonStrGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LAST_STARTUP_REASON_t	reason,
		open_buffdesc *	reasonStr
	)

Convert a startup reason to a string.

Parameters

[in]	client_handle	client handle from registration API
[in]	reason	reason
[out]	reasonStr	reason string

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

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_handle	Client handle from registration API
[in]	unitTypeIndex	Unit index
[out]	unitDescr	Unit description Buffer allocated size must be at least OPENAPI_SYSAPI_HPC_UNIT_DESCRIPTION_SIZE

Return values

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

Examples:

stacking_example.c.

open_error_t openapiUnitMgrSupportedLocalUnitIndexGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	unitTypeIdIndex
	)

Get the unit index of the local unit.

Parameters

[in]	client_handle	client handle from registration API
[out]	unitTypeIdIndex	index into the unit descriptor table

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrSupportedMgmtPrefGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unitTypeIdIndex,
		uint32_t *	unitMgmtPref
	)

Get the management preference of the unit index.

Parameters

[in]	client_handle	client handle from registration API
[in]	unitTypeIdIndex	index into the unit descriptor table
[out]	unitMgmtPref	preference

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrSupportedModelGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unitTypeIdIndex,
		open_buffdesc *	unitModel
	)

Get the supported unit model identifier for unit index.

Parameters

[in]	client_handle	client handle from registration API
[in]	unitTypeIdIndex	index into the unit descriptor table
[out]	unitModel	unit model

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrSupportedStmDefaultTemplateIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unitTypeIdIndex,
		uint32_t *	defaultTemplateId
	)

Get default template id for selected unit type index.

Parameters

[in]	client_handle	client handle from registration API
[in]	unitTypeIdIndex	index into the unit descriptor table
[out]	defaultTemplateId	default template

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

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_handle	Client handle from registration API
[in]	unitTypeIndex	Unit type index
[out]	unitType	Unit type of hardware used to determine stacking compatibility

Return values

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

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

Return values

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

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_handle	Client handle from registration API
[in]	unit	Unit number
[in]	unitTypeIndex	Unit type index
[in]	synchMode	Synchronous mode

Return values

OPEN_E_NONE	if successful
OPEN_E_FAIL	if create operation has failed
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[in]	unit	Unit number

Return values

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

Examples:

stacking_example.c.

open_error_t openapiUnitMgrUnitIdKeyGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		open_buffdesc *	key
	)

Get the unit system identifier key.

Parameters

[in]	client_handle	client handle from registration API
[in]	unit	unit number
[out]	key	mac address key

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

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

Return values

OPEN_E_NONE	if successful
OPEN_E_PARAM	if 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_handle	Client handle from registration API
[out]	unit	Unit number

Return values

OPEN_E_NONE	if successful
OPEN_E_PARAM	if 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 openapiUnitMgrUnitNumberChange	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		uint32_t	newUnitNumber
	)

Changes a unit's number.

Parameters

[in]	client_handle	client handle from registration API
[in]	unit	unit number
[in]	newUnitNumber	new unit number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

Note

Reset will be initiated after changing the number

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrUnitStatusClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit
	)

Clear the sampling information of unit status.

Parameters

[in]	client_handle	client handle from registration API
[in]	unit	unit number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

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_handle	Client handle from registration API
[in]	unit	Unit number
[out]	status	Unit status

Return values

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

Examples:

stacking_example.c.

open_error_t openapiUnitMgrUnitStatusInfoGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		openUnitStatusUnitInfo_t *	unit_info
	)

Get the status information of specified unit.

Parameters

[in]	client_handle	client handle from registration API
[in]	unit	unit number
[out]	unit_info	unit status information

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

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_handle	Client handle from registration API
[in]	targetUnit	Target unit

Return values

OPEN_E_NONE	if successful
OPEN_E_FAIL	if failed
OPEN_E_PARAM	if invalid parameter is supplied
OPEN_E_UNAVAIL	if the operation is not supported/unavailable

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

Return values

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

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_handle	Client handle from registration API
[in]	unit	Unit number
[out]	upTime	Up time

Return values

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

Examples:

stacking_example.c.

open_error_t openapiUnitMgrUserDescriptionGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		open_buffdesc *	descr
	)

Get unit user description.

Parameters

[in]	client_handle	client handle from registration API
[in]	unit	unit number
[out]	descr	description

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapiUnitMgrUserDescriptionSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		open_buffdesc *	descr
	)

Set unit user description.

Parameters

[in]	client_handle	client handle from registration API
[in]	unit	unit number
[out]	descr	description

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.27

Examples:

stacking_example.c.

open_error_t openapixUnitMgrRunCfgStatusGet	(	openapiClientHandle_t *	client_handle,
		OPEN_RUN_CFG_STATUS_t *	status
	)

Get the status of copying the running config to the backup unit.

Parameters

[in]	client_handle	client handle from registration API
[out]	status	status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.
OPEN_E_UNAVAIL	Unsupported.

OpEN API Version: 1.27

Examples:

stacking_example.c.