Restoring an Avaya Aura Device Services cluster

Last Updated : Jun 10, 2026 |

About this task

Use this procedure to restore an entire cluster. Restoring a cluster is useful if a failure occurs that results in the loss of all nodes.

To restore an Avaya Aura® Device Services node, you must install the Avaya Aura® Device Services software, then restore the configuration and data files from a previous backup.

Note:

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

Before you begin

Ensure that the application installation binary required to install Avaya Aura® Device Services is available.

Note:
The application installer must be the same version as the Avaya Aura® Device Services version that was used to create the backup.
If the virtual machine needs to be re-created, ensure that the OVA required to deploy the virtual machine is available.
Ensure that the required Avaya Aura® Device Services backup files are available for the nodes that are restored. Each node has its own specific backup file or backup directory. When restoring an Avaya Aura® Device Services node, you must use the correct backup file or directory for that node.
If you changed IP addresses or FQDNs of Avaya Aura® Device Services nodes, ensure that the required Avaya Aura® Device Services backup files were created after these changes. You cannot restore a node using backup files created before you changed the IP address or FQDN of the node.
Determine if the Utility Server was enabled on the system that you are restoring.

Procedure

Perform step 1 on the seed node first, and then on all non-seed nodes.

Reinstall the same version of Avaya Aura® Device Services that was backed up:
1. Redeploy the OVA if the node needs to be re-imaged.
  
  For more information about deploying OVAs, see the Initial setup section in Deploying Avaya Aura® Device Services.
2. Log in to the Avaya Aura® Device Services CLI as an administrator and run the following command:
```
app install
```
3. If the Utility Server was enabled on the system that you are restoring, enable the Utility Server from the Utility Server menu.
4. If you are reinstalling a non-seed node, in the Cluster Configuration menu, set Initial cluster node to n.
5. If you are reinstalling a non-seed node, in the Cluster Configuration menu, set Cluster seed node to the IP address of the seed node.
6. If you use Avaya Aura® Device Services in an Avaya Aura® environment, in the Front-end host, System Manager and Certificate Configuration menu, configure the following settings:
  - System Manager FQDN
  - System Manager Enrollment Password
  - Keystore password
7. If you use Avaya Aura® Device Services in an Avaya Aura® environment, in the Session Manager Configuration menu, configure the following settings:
  - Session Manager Management IP
  - Session Manager Asset IP
8. After the initial setup is completed, run the Configuration Utility using the app configure command.
9. If you use third-party identity certificates, in the Front-end host, System Manager and Certificate Configuration menu, configure the following options to provide the paths to the certificate and key files:
  - REST interface key file
  - REST interface certificate file
  - OAM interface key file
  - OAM interface certificate file
  - node key file
  - node certificate file
  - signing authority certificate file
10. If you enabled the Utility Server, configure the settings in the Clustering Configuration menu.
11. If the Utility Server was enabled on the system that you are restoring, in the Utility Server Configuration menu, configure the following settings:
  - Utility Server VIP
  - Utility Server FQDN
On the seed node, configure SSH/RSA public and private keys.

For more information, see Configuring RSA public and private keys for SSH connections in a cluster in Deploying Avaya Aura® Device Services.
If OAuth was enabled on the system that you are restoring, enable OAuth database replication on all nodes in the cluster.

For more information, see Enabling OAuth database replication in a cluster environment.
If onboard Open LDAP was enabled on the system that you are restoring, enable Open LDAP replication on all nodes in the cluster.

For more information, see Enabling Open LDAP replication.
If you use Avaya Aura® Device Services in an Avaya Aura® environment, on System Manager, verify that DRS replication is working for all nodes.

For more information, see Checking for DRS synchronization.
On the Avaya Aura® Device Services web administration portal, force LDAP synchronization and ensure that Avaya Aura® Device Services does not display the 503 Service Unavailable error.

Perform this step on each node in the cluster.

For more information, see Setting up user synchronization with the LDAP server.

Perform steps 1 to 4 on the seed node first and then on all non-seed nodes.

Copy the backup file or backup directory to the home directory of the administrative user using a file transfer utility, such as SFTP or SCP.

Ensure that you are using the backup file or backup directory created for the current node.
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_RESTORE
```
To restore the backed-up configuration files, run the following command:
```
app restore <path>
```
In this command, <path> is the absolute path to the backup file or backup directory.
When prompted, enter the password you used to create the backup.

If the password is wrong, Avaya Aura® Device Services prompts you to re-enter the password. After three failed attempts, Avaya Aura® Device Services aborts the restore process. In this case, you will need to run the app restore command again.
Repeat steps 7 to 10 on the non-seed nodes.
From the seed node, run the following command to repair the Cassandra database:
```
sudo /opt/Avaya/DeviceServices/<version>/CAS/<version>/cassandra/cassandraRepair.sh -M
```
If prompted, enter the Cassandra database user name and password. The default Cassandra database user name and password are aem_system and avaya123 respectively.

Next Steps

If the Utility Server is enabled on the system and you need to restore Utility Server data, see Restoring the Utility Server data.

Send Feedback

AVAYA DOCUMENTATION CENTER

No results found