Replicating Branch Gateway using a USB mass-storage device

Last Updated : Apr 28, 2023 |

About this task

The following procedure is useful for replicating Branch Gateway that has become faulty. Since the backup command backs up all the gateway configuration files, but does not back up any firmware files, the main task is to add the various firmware files before running restore.

Important:

When adding files to a backup directory on a USB mass-storage device, follow the file and directory naming convention to enable a successful restore.

Procedure

  1. Make sure you have a backup of the faulty Branch Gateway on a USB mass-storage device.
  2. Transfer the media modules, including the S8300 if installed, from the faulty Branch Gateway into the corresponding slots of the new Branch Gateway.
  3. Connect the new Branch Gateway to a power source.
  4. In the new Branch Gateway, enter show image version to find out which of the two image banks holds the older Branch Gateway firmware version, and what version it is.
  5. If the new Branch Gateway firmware version is 26.x.y or above, add Branch Gateway firmware to the USB mass-storage device, as follows:
    1. From Avaya support Website, download to your PC the same version of Branch Gateway firmware as was running in the faulty Branch Gateway.
    2. Insert the USB mass-storage device into the PC’s USB port.
    3. Copy Branch Gateway firmware file to the root backup directory in the USB mass-storage device.
  6. Add the firmware files of the media modules to the USB mass-storage device, as follows:
    1. From PLDS, download to your PC the firmware files of the media modules installed in the gateway.

      For each media module, download all firmware corresponding to the various hardware vintage/suffix versions available for that module. If you are not sure which media modules you have, you can download the firmware files of all media modules. The restore operation uses only the files needed.

    2. Insert the USB mass-storage device into the PC’s USB port.
    3. Copy the firmware files from the PC to the MM sub directory in the USB mass-storage device.

      Do not change the firmware file names.

  7. You can optionally add the firmware files of the IP phones to the USB mass-storage device, as follows:
    1. From PLDS, download to your PC the firmware files (booter and application) of up to two supported IP phones, as well as the 46xxupgrade.txt or 46xxupgrade.scr file.
    2. Insert the USB mass-storage device into the PC’s USB port.
    3. Copy the IP phone files from the PC to the USB mass-storage device.

      Place them in the IPPHONE sub directory under the root backup directory. Do not change the names of the downloaded files.

      Note:

      You will need to reset the IP phones after the restore operation on the gateway.

  8. View the backup directory on the USB mass-storage device.
  9. Enter key config-key password-encryption followed by the same passphrase that was used to create the Master Configuration Key (MCK) in the faulty gateway.

    This creates on the new gateway an MCK identical to the MCK in the faulty gateway, which enables the restore operation to decrypt the secrets in the configuration file.

    The restored configuration file will include all the configuration of the gateway, including user’s names and passwords, IKE pre-shared keys, and so on.

  10. Insert the USB mass-storage device in the new Branch Gateway USB port.
  11. Enter restore usb usbdevice0 backup-name, where backup-name is the backup directory path and file name on the USB mass-storage device.
  12. Enter show restore status to check the status of the restore operation.

    The report lists the files restored.

  13. Update the S8300 on the new Branch Gateway with the serial number of the new gateway, otherwise the gateway is not able to register in the CM.

    See Administrator’s Guide for Avaya Aura® Communication Manager .

Result

The new Branch Gateway is now a restored, fully-operational Branch Gateway.

Next Steps

Before unplugging the USB mass-storage device, use the safe-removal usb command to safely remove the USB mass-storage device.

Related information
Backing up administration and configuration files using a USB mass-storage device