Backing up Avaya Aura Web Gateway

Last Updated : Jun 10, 2026 |

About this task

Use this procedure to back up Avaya Aura® Web Gateway database and configuration files. This procedure applies to both standalone and cluster environments. In a cluster environment, you must back up files from all nodes in the cluster.

Note:

Avaya Aura® Device Services recommends that you start a Tmux session before running the backup command. If the SSH session terminates while the backup operation is in progress, you can re-connect to the Tmux session and complete the backup operation. For more information about the Tmux utility, see Using the Tmux utility.

Procedure

  1. Log in to the Avaya Aura® Web Gateway CLI as an administrative user.
  2. To start a Tmux session, run the following command:

    tmux new-session -s <NAME>

    In this command, NAME is a Tmux session name of your choice. For example:

    tmux new-session -s AAWG_backup_session

  3. To create a backup in a .tar.zip file, run one of the following commands:

    • app backup -t

    • app backup -t -P '<PASSWORD>'

    In the second command, <PASSWORD> is a password for protecting backup files. You must enclose the password with single quotation marks ('). If you do not enter a password or if the password does not comply with the password rules, Avaya Aura® Web Gateway prompts you to provide a password later. For information about supported characters, see Characters supported for Avaya Aura Web Gateway passwords.

    In a cluster environment, you can run this command on any node. It creates a backup for all nodes in the cluster.

    For example, to set the Password1234# password for your backups, run the following command:

    app backup -t -P 'Password1234#'
  4. If you did not enter a password for backups, then enter it when prompted.

    If the password does not comply with the password rules, Avaya Aura® Web Gateway prompts you to enter a new password.

  5. Re-enter the password to confirm it.
  6. Wait until the backup process is completed.
  7. Ensure that the backup file with the name <DateTimestamp>_<node_short-hostname>.tar.zip is present in the administration directory, which is located at /home/admin.
  8. To avoid losing backed up files on the server, save a copy of them on a remote storage server.

    You can add these files back to the server before restoring Avaya Aura® Web Gateway.

  9. Store the password that you used for backup files in a safe place.

    Avaya Aura® Web Gateway requires this password when you restore the backups.