Stacking

Provides configuration for stack members including unit management and stack firmware as well as obtaining configured and operational status.

Stacking OpEN API

This document provides a brief description of the Stacking OpEN APIs. It provides the following services:

• Get the next member of the current stack.
• Get the manager's unit number.
• Get the unit's status.
• Get the unit's management status.
• Get the configured and standby unit number and admin mode in the stack.
• Get the unit's model identifier string and pre-configured model identifier string assigned by HPC.
• Get the unit's version of code in flash.
• Get the unit's running version of code.
• Get the unit's hardware and admin management preference.
• Get the unit's type and index.
• Get unit description that corresponds to the index provided.
• Get stack firmware synchronization status of member unit.
• Get stack firmware synchronization status.
• Get stack firmware synchronization last attempt status.
• Get active template id of the stack unit.
• Get description of specified template id.
• Get the unit's up time in seconds.
• Get the unit's serial number.
• Get the unit's service tag.
• Get the unit's model identifier string assigned by HPC.
• Verify unit number.
• Get the maximum stacking unit number.
• Get unit type identifier that corresponds to the index provided.
• Get unit type identifier that corresponds to the next index.
• Create a new unit record for unit.
• Remove a unit only if it is not an active member of the stack.
• Transfers the management function from the current unit to another.
• Get QOS configuration for all front-panel stacking ports stack port.
• Set QOS configuration for all front-panel stacking ports stack port.
• Set the unit as standby in the stack.
• Get stacking mode configuration for a front-panel stack port.
• Set stacking mode configuration for a front-panel stack port.
• Verify slot number.
• List available slot(s) on given unit.
• Verify the slot is full.
• Get the admin mode of slot.
• Set the admin mode of slot.
• Get the power of slot.
• Set the power mode of slot.
• Get the card type.
• Get model and description of configured card.
• Get model and description of inserted card.
• Verify the slot is pluggable.
• Verify the slot is power down.
• Get running speed for a front-panel stack port.
• Get configured speed for a front-panel stack port.
• Set speed configuration for a front-panel stack port.

All 'Set' operations may affect the Switch behavior and configuration.

Example C Application stacking_example

Initialization

In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.

stacking_example

stacking_example.c is a sample application that demonstrates the use of the Stacking OpEN APIs. stacking_example is started from the command line and has the following usage syntax:

Usage: stacking_example <test#> <arg1> <arg2> ...

• Test 1: Get the next member of the current stack: stacking_example 1 <start-unit>
• Test 2: Get the manager's unit number: stacking_example 2
• Test 3: Get the unit's status: stacking_example 3 <unit>
• Test 4: Get the unit's management status: stacking_example 4 <unit>
• Test 5: Get the configured and standby unit number and admin mode in the stack: stacking_example 5
• Test 6: Get the unit's model identifier string and pre-configured model identifier string assigned by HPC: stacking_example 6 <unit>
• Test 7: Get the unit's version of code in flash: stacking_example 7 <unit>
• Test 8: Get the unit's running version of code: stacking_example 8 <unit>
• Test 9: Get the unit's hardware and admin management preference: stacking_example 9 <unit>
• Test 10: Get the unit's type and index: stacking_example 10 <unit>
• Test 11: Get unit description that corresponds to the index provided: stacking_example 11 <unit-type-index>
• Test 12: Get stack firmware synchronization status of member unit: stacking_example 12 <unit>
• Test 13: Get stack firmware synchronization status: stacking_example 13
• Test 14: Get stack firmware synchronization last attempt status: stacking_example 14 <unit>
• Test 15: Get active template id of the stack unit: stacking_example 15 <unit>
• Test 16: Get description of specified template id: stacking_example 16 <template-id>
• Test 17: Get the unit's up time in seconds: stacking_example 17 <unit>
• Test 18: Get the unit's serial number: stacking_example 18 <unit>
• Test 19: Get the unit's service tag: stacking_example 19 <unit>
• Test 20: Get the unit's model identifier string assigned by HPC: stacking_example 20 <unit>
• Test 21: Verify unit number: stacking_example 21 <unit>
• Test 22: Get the maximum stacking unit number: stacking_example 22
• Test 23: Get unit type identifier that corresponds to the index provided: stacking_example 23 <unit-type-index>
• Test 24: Get unit type identifier that corresponds to the next index: stacking_example 24 <unit-type-index>
• Test 25: Create a new unit record for unit: stacking_example 25 <unit> <unit-type-index> <synch-mode>
• Test 26: Remove a unit only if it is not an active member of the stack: stacking_example 26 <unit>
• Test 27: Transfers the management function from the current unit to another: stacking_example 27 <target-unit>
• Test 28: Get QOS configuration for all front-panel stacking ports stack port: stacking_example 28
• Test 29: Set QOS configuration for all front-panel stacking ports stack port: stacking_example 29 <fps-qos-mode>
• Test 30: Set the unit as standby in the stack: stacking_example 30 <standby-unit> <standby-admin-mode>
• Test 31: Get stacking mode configuration for a front-panel stack port: stacking_example 31 <unit> <slot> <port>
• Test 32: Set stacking mode configuration for a front-panel stack port: stacking_example 32 <unit> <slot> <port> <stack-port-mode>
• Test 33: Verify slot number: stacking_example 33 <unit> <slot>
• Test 34: List available slot(s) on given unit: stacking_example 34 <unit>
• Test 35: Verify the slot is full: stacking_example 35 <unit> <slot>
• Test 36: Get the admin mode of slot: stacking_example 36 <unit> <slot>
• Test 37: Set the admin mode of slot: stacking_example 37 <unit> <slot> <admin mode>
• Test 38: Get the power of slot: stacking_example 38 <unit> <slot>
• Test 39: Set the power mode of slot: stacking_example 39 <unit> <slot> <power mode>
• Test 40: Get the card type: stacking_example 40 <unit> <slot>
• Test 41: Get model and description of configured card: stacking_example 41 <unit> <slot>
• Test 42: Get model and description of inserted card: stacking_example 42 <unit> <slot>
• Test 43: Verify the slot is pluggable: stacking_example 43 <unit> <slot>
• Test 44: Verify the slot is power down: stacking_example 44 <unit> <slot>
• Test 45: Transfer arbitrary file from mgmr to member unit: stacking_example 45 <unit> <src_file> <dst_file>
• Test 46: Get running speed for a front-panel stack port: stacking_example 46 <uni> <slot> <port>
• Test 47: Get configured speed for a front-panel stack port: stacking_example 47 <unit> <slot> <port>
• Test 48: Set speed configuration for a front-panel stack port: stacking_example 48 <unit> <slot> <port> <stack-port-speed>
• Test 49: Get the unit index of the local unit: stacking_example 49
• Test 50: Get the unit model identifier: stacking_example 50 <unit>
• Test 51: Get default template id for selected unit type index: stacking_example 51
• Test 52: Get management preference of the unit index: stacking_example 52 <unit>
• Test 53: Get the first member of the current stack: stacking_example 53
• Test 54: Get the unit system identifier key: stacking_example 54 <unit>
• Test 55: Set the admin management preference: stacking_example 55 <unit> <admin pref>
• Test 56: Initiate a warm failover to the backup unit: stacking_example 56
• Test 57: Administratively enable or disable nonstop forwarding: stacking_example 57 <1/0>
• Test 58: Get the administrative status of nonstop forwarding: stacking_example 58
• Test 59: Get the reason for the last restart: stacking_example 59
• Test 60: Convert a startup reason to a string: stacking_example 60 <reason number>
• Test 61: Convert a run config status to a string: stacking_example 61 <config status>
• Test 62: Get the age of the configuration on the backup unit: stacking_example 62
• Test 63: Get the status of copying the running config to the backup unit: stacking_example 63
• Test 64: Next running config copy to backup , if a copy is scheduled: stacking_example 64
• Test 65: Get this unit's nonstop forwarding support: stacking_example 65 <unit>
• Test 66: Get stack status information and display: stacking_example 66 <unit>
• Test 67: Change a unit's number: stacking_example 67 <unit> <new unit>
• Test 68: Erase the startup-config file on other connected units: stacking_example 68
• Test 69: Erase the factory-defaults file on other connected units: stacking_example 69
• Test 70: Set unit user description: stacking_example 70 <unit> <description>
• Test 71: Get unit user description: stacking_example 71 <unit>
• Test 72: Get stack firmware synchronication mode: stacking_example 72
• Test 73: Set stack firmware synchronication mode: stacking_example 73 <0/1>
• Test 74: Get stack firmware synchronication trap mode: stacking_example 74
• Test 75: Set stack firmware synchronication trap mode: stacking_example 75 <0/1>
• Test 76: Get stack firmware synchronication downgrade mode: stacking_example 76
• Test 77: Set stack firmware synchronication downgrade mode: stacking_example 77 <mode>
• Test 78: Set the mode of sample collection, size of sample: stacking_example 78 <mode> <size>
• Test 79: Clear the sampling information of unit status: stacking_example 79 <unit>
• Test 80: Reset stack config on a unit: stacking_example 80 <unit>
• Test 82: Erase the DHCP client configuration file on the stand-by unit: stacking_example 82
• Test 83: Clear stack counters for all stack ports: stacking_example 83
• Test 84: Determine if a given port is stack capable: stacking_example 84
• Test 85: Set hash mode configuration for all HG trunks: stacking_example 85 <mode>
• Test 86: Get the hash mode configuration for all HG trunks: stacking_example 86
• Test 87: To check if the hash mode is configurable: stacking_example 87 <mode>

It exercises all the Stacking OpEN APIs with appropriate arguments to manage the Stacking component in the EFOS main process (switchdrvr).

Stacking CLI/API Cross Reference

CLI Command	OpEN API Reference
(Config)# show slot	openapiUnitMgrStackMemberGetNext()
(Config)# show stack-status <unit>	openapiUnitMgrUnitStatusGet()
(Config)# show switch <unit>	openapiUnitMgrStandbyGet() openapiUnitMgrModelIdentifierGet() openapiUnitMgrDetectCodeVerFlashGet() openapiUnitMgrDetectCodeVerRunningGet() openapiUnitMgrMgmtPrefGet() openapiUnitMgrUnitTypeGet() openapiUnitMgrSupportedDescriptionGet() openapiUnitMgrStackFirmwareSyncMemberStatusGet() openapiUnitMgrStackFirmwareSyncStatusGet() openapiUnitMgrStackFirmwareSyncMemberLastAttemptStatusGet() openapiUnitMgrUnitUpTimeGet() openapiUnitMgrPreconfigModelIdGet()
(Config)# show version	openapiUnitMgrNumberGet() openapiUnitMgrSerialNumberGet()
(Config)# show system id	openapiUnitMgrServiceTagGet()
(Config)# show slot <unit> <slot>	openapiSlotGet() openapiUnitDbEntrySlotsGet() openapiSlotIsFullGet openapiSlotAdminModeGet() openapiSlotPowerModeGet() openapiCardTypeGet() openapiCardSupportedCardModelIdGet() openapiCardSupportedCardDescriptionGet() openapiSlotSupportedPluggableGet() openapiSlotSupportedPowerdownGet()
(Config)# set slot disable <unit> <slot>	openapiSlotAdminModeSet()
(Config)# set slot power <unit> <slot>	openapiSlotPowerModeSet()
(Config)# switch <unit> priority	openapiUnitMgrAdminMgmtPrefSet()
(Config)# switch <unit> renumber <newunit>	openapiUnitMgrUnitNumberChange()
(Config-stack)# stack-port <intf> stack speed 10g	openapiSpmFpsStackingConfigSpeedSet()
(Config-stack)# stack-port <intf> stack speed 25g	openapiSpmFpsStackingConfigSpeedSet()
(Config-stack)# initiate failover	openapiFailoverInitiate()
(Config-stack)# trunk-hashmode <mode>	openapiStackTrunkHashModeSet
(Config-stack)# nsf	openapiUnitMgrNsfAdminSet()
(Config-stack)# stack-status sample-mode	openapiUnitMgrSampleModeSet()
(Priv-User Mode)# show stack-port speed	openapiSpmFpsStackingRunningSpeedGet() openapiSpmFpsStackingConfigSpeedGet()
(Priv-User Mode)# boot auto-copy-sw	openapiUnitMgrStackFirmwareSyncModeSet()
(Priv-User Mode)# boot auto-copy-sw allow-downgrade	openapiUnitMgrStackFirmwareSyncAllowDowngradeModeSet()
(Priv-User Mode)# boot auto-copy-sw trap	openapiUnitMgrStackFirmwareSyncTrapModeSet()
(Priv-User Mode)# erase startup-config	openapiUnitMgrEraseStartupConfig()
(Priv-User Mode)# erase factory-defaults	openapiUnitMgrEraseFactoryDefaults()
(Priv-User Mode)# erase stack-config	openapiUnitMgrStackConfigReset()
(Priv-User Mode)# show supported switchtype	openapiUnitMgrSupportedLocalUnitIndexGet() openapiUnitMgrSupportedModelGet() openapiUnitMgrSupportedMgmtPrefGet() openapiUnitMgrSupportedDescriptionGet()
(Priv-User Mode)# show nsf	openapiUnitMgrStackMemberGetFirst() openapiUnitMgrNsfAdminGet() openapiUnitMgrStartupReasonGet() openapiUnitMgrStartupReasonStrGet() openapixUnitMgrRunCfgStatusGet() openapiUnitMgrRunCfgStatusString() openapiUnitMgrConfigAgeOnBackup() openapiUnitMgrNextConfigCopyTime() openapiUnitMgrNsfSupportGet()
(Priv-User Mode)# show auto-copy-sw	openapiUnitMgrStackFirmwareSyncModeGet() stackUnitMgrStackFirmwareSyncTrapModeGet() openapiUnitMgrStackFirmwareSyncAllowDowngradeModeGet
(Priv-User Mode)# show stack-hashmode	openapiStackTrunkHashModeGet()
(Priv-User Mode)# show hardware	openapiUnitMgrUnitIdKeyGet()
(Priv-User Mode)# show stack-status all	openapiUnitMgrUnitStatusInfoGet()