ADB Replacement

This section describes how to replace ADBs in deployed standalone Solace PubSub+ appliances. It also describes how to replace ADBs in one or both appliances in a high-availability (HA) redundant appliance pair. These replacement procedures will preserve any spooled messages.

The replacement ADB must be the same model as that it is replacing or a newer model that is compatible with the appliance chassis type. Also, if the appliance belongs to an HA pair, the ADBs used by each appliance must be compatible models. For more information, contact Solace.

ESD/Safety Precautions

To prevent equipment damage from Electrostatic Discharge (ESD), always ensure that the appliance chassis is electrically connected to earth ground. Always follow ESD prevention procedures when removing and replacing power supplies. Use an anti-static wrist strap, or another anti-static device. If no wrist strap or mat is available, touch the metal housing of the chassis to ground yourself.

Tool and Equipment Requirements

The following tools and equipment are required to replace an ADB in an appliance:

  • Electrostatic discharge wrist strap
  • Anti-static mat
  • Anti-static packaging for ADB
  • No. 1 Phillips head screwdriver ( Solace PubSub+ 3260)
  • No. 2 Phillips head screwdriver (Solace PubSub+ 3530 and 3560)
  • A compatible replacement ADB (ordered from Solace)

Procedure for Standalone Appliances

Perform the following steps to replace an ADB in a standalone appliance:

  1. Determine the current version of Solace PubSub+ software that is running and ensure that it is compatible with the replacement ADB you will be installing:

    solace> show version

    You may need to upgrade the appliance's version depending on the model of the replacement ADB. For example, if you are replacing an ADB-000000-02 or an ADB‑04210M-01 with an ADB‑000004-01, the appliance must use software version 8.0.0 or greater.

  2. As a protective measure, make a copy of the current Solace PubSub+ configuration in the /configs subdirectory:

    solace> enable
    solace# copy current-config
    /configs/<version>_preBladeReplacementCfg

    Where:

    <version> is the version number of current Solace PubSub+ software as seen in the output of the, show version, User EXEC command.

  3. Upgrade the version if necessary.

    For upgrading information, refer to the Upgrade Procedures for the version you want to upgrade to.

  4. Ensure that the internal disks are in a redundant state.

    solace> show disk

    If the displayed output shows the RAID disk drives to be in a non‑redundant state, contact Solace, and stop this hardware replacement procedure immediately to prevent software corruption on the appliance.

  5. Enter the following command to verify the event broker is correctly configured.

    solace> show message-spool

    The primary event broker should show Config Status: Enabled (Primary), Operational Status: AD-Active, and a Datapath Status: Up.

  6. Determine whether routing is enabled:

    solace> show routing

  7. Shut down routing if it is enabled:

    solace# configure
    solace(configure)# routing
    solace(configure/routing)# shutdown
    solace(configure/routing)# exit

  8. Shut down messaging services:

    solace(configure)# service msg-backbone
    solace(configure/service/msg-backbone)# shutdown
    All SMF, WEB, and REST clients will be disconnected
    Do you want to continue (y/n)? y
    solace(configure/service/msg-backbone)# exit

  9. If the appliance is handling transacted sessions, wait until all transacted sessions time-out and the count drops to 0. This could take up to three minutes.

    Enter the following command to view the transacted sessions in use (the following example only shows the relevant transacted session usage lines):

    solace# show message-spool detail

  10. Shut down the message spool:

    solace(configure)# hardware message-spool
    solace(configure/hardware/message-spool)# shutdown
    All message spooling will be stopped.
    Do you want to continue (y/n)? y
    solace(configure/hardware/message-spool)# exit
    solace(configure)# exit

  11. Enter the following command to view the total number of spooled messages, and for reference, write down the total number of spooled message:

    solace> show message-spool

  12. Backup the ADB configuration to the event broker internal disk and export any currently spooled messages from the Guaranteed message spool to the configured internal disk or external disk array.

    solace# admin
    solace(admin)# system
    solace(admin/system)# message-spool
    solace(admin/system/message-spool)# backup-adb-to-disk
    On the next system startup, the backed-up ADB state on disk will overwrite
    the current ADB state.
    Do you want to continue (y/n)? y

  13. Once the CLI output indicates that the ADB backup operation has completed, enter the following command to display the message spool contents. Ensure that there are no messages spooled on the ADB and all messages are spooled to disk.

    solace(admin/system/message-spool)# end
    solace# show message-spool

    If there are messages spooled to the ADB, or the number of messages spooled to disk is not the same as the total number of messages recorded earlier, do not continue. Contact Solace for assistance.

  14. Turn off the event broker:

    solace# power-down

  15. Physically replace the ADB with the new ADB:
  16. After the new ADB has been installed in the chassis, power up the appliance.
    • For a Solace PubSub+ 3230 or 3260, use a paper clip to press the () on/standby button on the front panel of the appliance.
    • For a Solace PubSub+ 3530 or 3560, press the () on/standby button on the rear panel of the appliance.

    Alternately, use WOL to turn power back on to the appliance through a WOL magic packet (refer to Powering Up an Appliance With WOL for details).

  17. Wait for the supercapacitor on the ADB to fully charge. This could take up to 15 minutes. To determine its charge level, enter the following command:

    solace> show hardware detail

  18. Start the message spool that was shut down:

    solace> enable
    solace# configure
    solace(configure)# hardware message-spool
    solace(configure/hardware/message-spool)# no shutdown primary
    solace(configure/hardware/message-spool)# exit

  19. Start the messaging services that were shut down:

    solace(configure)# service msg-backbone
    solace(configure/service/msg-backbone)# no shutdown
    solace(configure/service/msg-backbone)# exit

  20. If routing was shut down in step 7, start routing:

    solace# configure
    solace(configure)# routing
    solace(configure/routing)# no shutdown
    solace(configure/routing)# end

  21. To ensure that the message spool is in an AD‑Active state, enter the following command :

    solace# show message-spool detail

Procedures for Redundant Appliances

For appliances configured in an HA redundant pair, you can either:

When appliances are configured in HA redundant pairs, the ADBs used by each appliance must be compatible models.

Replacing One ADB in a Redundant Pair

When appliances are configured in an HA redundant pair, you can replace the ADB used in one of the appliances with an ADB that is compatible with the one used by its mate. For example, this can be done when an ADB failure has occurred and one of the appliances in the HA redundant pair is handling all messaging activity.

In the example command line snippets provided below, the ADB replacement is performed for the appliance, solace1, which is configured as primary event broker in the redundant pair. However, the ADB can be replaced in an appliance serving as either the active or backup event broker in the HA pair.

To replace the ADB of one of the appliances that belongs to an HA redundant pair, perform the following steps:

  1. As a protective measure, for the appliance for which you are replacing the ADB, make a copy of the current Solace PubSub+ configuration in the /configs subdirectory:

    solace1> enable
    solace1# copy current-config /configs/<version>_preBladeReplacementCfg

    Where:

    <version> is the version number of current Solace PubSub+ software as seen in the output of the show version User EXEC command.

  2. On the appliance that you are replacing the ADB for, enter the following command to ensure that it surrenders activity for its virtual router VRIDs to its mate appliance:

    solace1(configure)# redundancy
    solace1(configure/redundancy)# release-activity
    solace1(configure/redundancy)# exit

  3. On the appliance that you are replacing the ADB for, confirm that the backup appliance has taken activity:

    solace1# show redundancy

    If the mate appliance has not taken activity, do NOT proceed with the replacement procedure. Instead, contact Solace for further instructions.

  4. Power down the appliance:

    solace1# power-down

  5. Physically replace the ADB with the new ADB:
  6. After the new ADB has been installed in the chassis, power up the appliance.
    • For a Solace PubSub+ 3230 or 3260, use a paper clip to press the () on/standby button on the front panel of the appliance.
    • For a Solace PubSub+ 3530 or 3560, press the () on/standby button on the rear panel of the appliance.

    Alternately, use WOL to turn power back on to the appliance through a WOL magic packet (refer to Powering Up an Appliance With WOL for details).

  7. Wait for the supercapacitor on the ADB to fully charge. This could take up to 15 minutes. To determine its charge level, enter the following command:

    solace> show hardware detail

  8. To allow activity to return back to the event broker, enter the following commands:

    solace1> enable
    solace1# configure
    solace1(configure)# redundancy
    solace1(configure-redundancy)# no release-activity
    solace1(configure-redundancy)# end

  9. Optional: Enter the following commands on the mate event broker to force it back to its original redundancy state:

    solace2> enable
    solace2# admin
    solace2(admin)# redundancy revert-activity
    solace2(admin)# end

  10. On the appliance that you replaced the ADB, enter the following command to confirm that activity status for each virtual router is correct.

    solace1# show redundancy

Replacing Both ADBs in a Redundant Pair

To replace the ADBs in both the primary and backup appliances of a redundant pair, follow this procedure:

  1. Enter the following commands for both the primary and backup appliance to determine the current version of Solace PubSub+ software that they are running:

    solace1> show version

    solace2> show version

    You may need to upgrade the applianceʼs version depending on the model of the replacement ADB. For example, if you are replacing an ADB-000000-02 or an ADB‑04210M-01 with an ADB‑000004-01, the appliance must use version 8.0.0 or greater.

  2. As a protective measure, copy the current configuration of both appliances.

    solace1> enable
    solace1# copy current-config /configs/<version>_preBladeReplacementCfg

    solace2> enable
    solace2# copy current-config /configs/<version>_preBladeReplacementCfg

    Where:

    <version> is the version number of current Solace PubSub+ software as seen in the output of the show version command.

  3. Upgrade the version if necessary.

    For upgrading information, refer to the Upgrade Procedures for the version you want to upgrade to.

  4. Ensure that the primary appliance is in the correct redundancy state:

    solace1# show redundancy

  5. Ensure that the backup appliance is in the correct redundancy state:

    solace2# show redundancy

  6. Check to see if the Solace routing protocols are running on either appliance:

    solace1# show routing

    solace2# show routing

    If routing is enabled on either appliance, you'll see a line that looks like this in the command's output:

    Enabled: Yes

    If you see Yes in the output, stop the Solace routing protocols on the appropriate appliance:

    solace1# configure
    solace1(configure)# routing
    solace1(configure/routing)# shut
    solace1(configure/routing)# exit

    solace2# configure
    solace2(configure)# routing
    solace2(configure/routing)# shut
    solace2(configure/routing)# exit

  7. Shut down messaging services on both appliances:

    solace1(configure)# service msg-backbone
    solace1(configure/service/msg-backbone)# shutdown
    All clients will be disconnected.
    Do you want to continue (y/n)? y
    solace1(configure/service/msg-backbone)# exit
    solace1(configure/service)# exit

    solace2(configure)# service msg-backbone
    solace2(configure/service/msg-backbone)# shutdown
    All clients will be disconnected.
    Do you want to continue (y/n)? y
    solace2(configure/service/msg-backbone)# exit
    solace2(configure/service)# exit

  8. Ensure that auto-revert is not enabled for either appliance:

    solace1(configure)# redundancy
    solace1(configure/redundancy)# no auto-revert
    solace1(configure/redundancy)# end

    solace2(configure)# redundancy
    solace2(configure/redundancy)# no auto-revert
    solace2(configure/redundancy)# end

  9. If the appliances are using transacted sessions, wait until all transacted sessions time-out and the count drops to 0. This could take up to three minutes.

    Enter the following command to view the transacted sessions in use (the following example only shows the relevant transacted session usage lines):

    solace1# show message-spool detail

  10. Shut down the message spools on both appliances:

    solace1# configure
    solace1(configure)# hardware message-spool
    solace1(configure/hardware/message-spool)# shutdown
    All message spooling will be stopped.
    Do you want to continue (y/n)? y
    solace1(configure/hardware/message-spool)# end

    solace2# configure
    solace2(configure)# hardware message-spool
    solace2(configure/hardware/message-spool)# shutdown
    All message spooling will be stopped.
    Do you want to continue (y/n)? y
    solace2(configure/hardware/message-spool)# end

  11. Enter the following command on the primary appliance to release activity to the backup appliance:

    solace1# configure
    solace1(configure)# redundancy
    solace1(configure/redundancy)# release-activity
    solace1(configure/redundancy)# end
    solace1#

  12. Enter the following command on the primary appliance to confirm that the backup appliance has taken activity:

    solace1# show redundancy

    The Activity Status for both virtual routers should be “Mate Active”.

    If the backup has not taken activity, DO NOT proceed with the upgrade. Contact Solace for further instructions.

  13. Enter the following command on the primary appliance to view the total number of spooled messages, and, for reference, write down the total number of spooled messages:

    solace1# show message-spool

  14. Enter the following commands on the primary appliance to backup the ADB to disk:

    solace1# admin
    solace1(admin)# system
    solace1(admin/system)# message-spool
    solace1(admin/system/message-spool)# backup-adb-to-disk
    On the next system startup, the backed-up ADB state on disk will overwrite
    the current ADB state.
    Do you want to continue (y/n)? y
    Moving ADB messages to disk: 100%
    Backing up ADB config to disk: 100%
    solace1(admin/system/message-spool)# end

  15. Turn off the primary appliance:

    solace1# power-down

  16. Physically replace the ADB with the new, Solace provided ADB:
  17. After the new ADB has been properly installed in the chassis, power up the appliance:
    • For a Solace PubSub+ 3230 or 3260, use a paper clip to press the () on/standby button on the front panel of the appliance.
    • For a Solace PubSub+ 3530 or 3560, press the () on/standby button on the rear panel of the appliance.

    Alternately, use WOL to turn power back on to the appliance through a WOL magic packet (refer to Powering Up an Appliance With WOL for details).

  18. Wait for the supercapacitor on the ADB to fully charge. This could take up to 15 minutes. To determine its charge level, enter the following command:

    solace1> show hardware detail

  19. Enter the following commands to release activity to the primary appliance from the backup appliance:
    1. Enter the following commands on the primary appliance to allow activity to return back to it:

      solace1# configure
      solace1(configure)# redundancy
      solace1(configure/redundancy)# no release-activity
      solace1(configure/redundancy)# end

    2. Enter the following commands on the backup appliance to administratively force it to give up service:

      solace2# configure
      solace2(configure)# redundancy
      solace2(configure/redundancy)# release-activity
      solace2(configure/redundancy)# end

  20. Confirm that the backup appliance has released activity for both virtual routers:

    solace2# show redundancy

    If the backup appliance is not Mate Active for both virtual routers, DO NOT proceed with the card replacement. Instead, contact Solace for further instructions.

  21. Power down the backup appliance:

    solace2# power-down

  22. Physically replace the ADB with the new ADB:
  23. After the new ADB has been installed in the chassis, power up the appliance:
    • For a Solace PubSub+ 3230 or 3260, use a paper clip to press the () on/standby button on the front panel of the appliance.
    • For a Solace PubSub+ 3530 or 3560, press the () on/standby button on the rear panel of the appliance.

    Alternately, use WOL to turn power back on to the appliance through a WOL magic packet (refer to Powering Up an Appliance With WOL for details).

  24. Wait for the supercapacitor on the ADB to fully charge. This could take up to 15 minutes. To determine its charge level, enter the following command:

    solace2> show hardware detail

  25. On the backup appliance, enter the following commands to prepare it to accept activity:

    solace2# configure
    solace2(configure)# redundancy
    solace2(configure/redundancy)# no release-activity
    solace2(configure/redundancy)# end

  26. On the primary appliance, enter the following commands to force it back to its original redundancy state:

    solace1# admin
    solace1(admin)# redundancy revert-activity
    solace1(admin)# end

  27. On the primary event broker, enter the following command to confirm that it is active for the primary virtual router and the backup event broker is active for the backup virtual router. The Activity Status line should read “Subscriptions pending” for the primary virtual router and “Mate Active” for the backup virtual router:

    solace1# show redundancy

    If the activity status is not correct, DO NOT proceed with the upgrade. Contact Solace technical support for further instructions.

  28. On both appliances, start the message spools that were shut down:

    solace1# configure
    solace1(configure)# hardware message-spool
    solace1(configure/hardware/message-spool)# no shutdown primary
    solace1(configure/hardware/message-spool)# exit
    solace1(configure/hardware)# exit

    solace2# configure
    solace2(configure)# hardware message-spool
    solace2(configure/hardware/message-spool)# no shutdown backup
    solace2(configure/hardware/message-spool)# exit
    solace2(configure/hardware)# exit

  29. On both appliances, start the messaging services that were shut down:

    solace1(configure)# service msg-backbone
    solace1(configure/service/msg-backbone)# no shutdown
    solace1(configure/service/msg-backbone)# end

    solace2(configure)# service msg-backbone
    solace2(configure/service/msg-backbone)# no shutdown
    solace2(configure/service/msg-backbone)# end

  30. If routing was previously enabled on both appliances, start the Solace routing protocols:

    solace1# configure
    solace1(configure)# routing
    solace1(configure/routing)# no shut
    solace1(configure/routing)# end

    solace2# configure
    solace2(configure)# routing
    solace2(configure/routing)# no shut
    solace2(configure/routing)# end

  31. Ensure that the primary appliance is in the correct redundancy state:

    solace1# show redundancy

  32. Ensure that the backup appliance is in the correct redundancy state:

    solace2# show redundancy