Backing up Avaya Aura Device Services

Last Updated : Jun 10, 2026 |

About this task

Use this procedure to back up Avaya Aura® Device Services configuration files and user data. This procedure applies to both standalone and cluster environments. In a cluster environment, you can perform the backup procedure from any node.

Note:

  • Avaya 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.

  • Backing up Avaya Aura® Device Services does not back up the Utility Server data. For more information about backing up data stored on the Utility Server, see Backing up data stored on the Utility Server.

Procedure

  1. Log in to the Avaya Aura® Device Services CLI as an administrator.
  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 AADS_backup_session

  3. To create a backup, run one of the following commands:

    • app backup -t To create a backup in a .tar.zip file.

    • app backup To create a backup in a directory.

  4. If you created your backup in a .tar.zip file, provide a password when prompted and then re-enter the password to confirm.

    If the password does not comply with the password complexity rules, Avaya Aura® Device Services prompts you to enter a new password. For more information about the password complexity rules, see passwdrules command.

  5. When prompted with Yes for proceed, all else for cancel, type Yes and then press Enter.

    Avaya Aura® Device Services creates a backup file in the administrator’s home directory. In a cluster environment, backup files are created on each cluster node.

  6. Ensure that the administrator’s home directory contains the backup file or backup directory.
  7. Copy the backup files to an external storage using a file transfer program, such as SFTP or SCP.
  8. In a cluster environment, repeat steps 6 and 7 on all remaining nodes in the cluster.
  9. To retrieve the casandra username and password, refer to Retrieving Cassandra database username and password.
  10. To locate the keystore password, refer to Locating keystore password.