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.
About this task
Note:
Avaya Aura® Web Gateway recommends that you run the Screen utility before running the backup command. If the SSH session terminates while the backup operation is in progress, you can re-connect to the Screen session and complete the backup operation.
Procedure
Log in to the Avaya Aura® Web Gateway CLI as an administrative user.
To start the Screen utility, run the following command:
screen -S <SESSION_NAME>
In this command, SESSION_NAME is a Screen session name of your choice. For example:
screen -S AAWG_backup_session
If the SSH session is reset when you create a backup, you can re-connect to the Screen session and complete the backup operation.
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#'
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.
Re-enter the password to confirm it.
Wait until the backup process is completed.
Optional If the SSH session terminates while the backup operation is in progress, do the following to restore the session:
Log in to the Avaya Aura® Web Gateway CLI as an administrator.
To obtain the ID of the Screen session, run the following command:
screen -ls
Avaya Aura® Web Gateway displays the results in the following format:
<SESSION_ID>.<SESSION_NAME>
In this entry, <SESSION_ID> is the Screen session ID and <SESSION_NAME> is the Screen session name that you provided.
To reattach to the appropriate session, run the following command:
screen -rd <SESSION_ID>
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.
Copy the backup files to an external storage using a file transfer program, such as SFTP or SCP.
In a cluster environment, repeat step 8 and 9 on all remaining nodes in the cluster.
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.
Next Steps
Complete the remaining steps to prepare for migration.
