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

Go to the source code of this file.

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