Configuring the virtual IP address for Avaya Aura Device Services clusters

Last Updated : Jun 10, 2026 |

About this task

In cluster environments, Avaya Aura® Device Services uses a virtual IP address to interact with clients. You must configure a virtual IP for the cluster seed node before installing other cluster nodes. Then configure a virtual IP for a non-seed node that will be used as a backup node for the seed node.

You only need to configure the virtual IP if you use the on-board Nginx load balancer in the cluster. If you are using an external load balancer, you must disable the virtual IP and set the front-end FQDN to the FQDN of the external load balancer.

Note:

If you use a virtual IP address, you must use it or the front-end FQDN to access Avaya Aura® Device Services the following resourses over port 443:

  • https://<AADS_IP>:443/acs/resources/<RESOURCE_NAME>

  • https://<AADS_IP>/acs/resources/<RESOURCE_NAME>

When a virtual IP is enabled, Avaya Aura® Device Services blocks access to these resources over port 443 for node IP addresses and node FQDNs.

Procedure

  1. Log in to the Avaya Aura® Device Services CLI as an administrator.
  2. Run the app configure command.
  3. In the Avaya Aura Device Services Configuration Utility dialog box, click Front-end host, System manager and Certificate Configuration and click Select.
  4. Click Front-end FQDN and then click Select.
  5. Type the FQDN of the virtual IP and then click OK.
  6. Click Local frontend host and then click Select.
  7. Type the FQDN of the node to which you have logged in and then click OK.
  8. Click Apply.
  9. Click Clustering Configuration and then click Select.
  10. Click Virtual IP Configuration and then click Select.
  11. Click Enable Virtual IP.

    Avaya Aura® Device Services enables the virtual IP address that forms the interface for client requests in the clustered environment. Avaya Aura® Device Services displays Enable or disable Virtual IP handling on this node.

  12. Click Yes to enable the virtual IP address.
  13. Click Virtual IP Address and then click Select.
  14. Type the IP address that forms the front end to the clients and then click OK.
  15. Click Virtual IP Interface and then click Select.
  16. Type the Ethernet interface over which the virtual IP must be configured.

    For example, in Virtual IP Interface, type eth0.

  17. Click Virtual IP master node and then click Select.
  18. Do one of the following:

    • For the initial or seed node, click Yes.

    • For the backup in the cluster, click No.

  19. Click Virtual IP router ID and then click Select.
  20. Type a value between 1 and 255 and then click OK.

    The Virtual IP router ID in the master and backup Avaya Aura® Device Services instances must match. The default value for this field is 61. When an Avaya Multimedia Messaging cluster and an Avaya Aura® Device Services cluster are configured on the same subnet, the Virtual IP router ID differentiates between the clusters. The Virtual IP router ID must be unique for each cluster.

  21. Click Virtual IP authentication password and click Select.
  22. Type the password for the virtual IP address and click OK.
  23. Click Apply to continue.

    Avaya Aura® Device Services displays the results of the virtual IP configuration.

  24. Click Continue.
  25. Click Return to Main Menu.
  26. Click Continue to continue with the virtual IP configruation.

    Avaya Aura® Device Services restarts services.

  27. Run the app configure command for another node in the cluster and repeat the previous steps to configure a virtual IP.

    This node is designated as the backup node when you set Virtual IP Master Node to n. Virtual IP configuration is required only for the master and backup nodes in the cluster, and not for subsequent nodes in the cluster.

  28. On the Avaya Aura® Device Services administration portal, go to Cluster Configuration > Cluster Nodes to confirm whether Avaya Aura® Device Services are running.