runUserDiagnostics tool

Last Updated : Jun 10, 2026 |

The runUserDiagnostics tool is used with the clitool-acs.sh tool for collecting and dumping user and contact-related information.

You can run the command for a user by:

  • specifying the user’s email ID

  • specifying a filename that contains comma separated email IDs of more than one user

    The tool generates an excel file for each user. The file name contains the email address of the user to distinguish the file name for each user.

Syntax

sudo ./clitool-acs.sh runUserDiagnostics [-e email_address] [-f <absolute_filepath><filename>] [-d <email_address>][-a]
e

Creates an excel file in /opt/Avaya/ directory that contains contact-related information for the email ID specified

f

Creates excel files in /opt/Avaya/ directory that contains contact-related information for each email ID specified in the text file

d

Deregisters a registered user and removes all user related data from Avaya Aura® Device Services

a

Creates an excel file in /opt/Avaya/ directory that contains the number of contacts in Session Manager and Avaya Aura® Device Services for all registered Avaya Aura® Device Services users

email_address

Email address of a user

filename

Filename containing comma separated email IDs. The file must be accessible from the misc directory for clitool and stored under opt/Avaya or a sub-directory.

absolute_filepath

Absolute filepath of the directory where the filename containing comma separated email IDs is stored.

Example

The following examples show how the runUserDiagnostics tool can be used with the available features.

sudo ./clitool-acs.sh runUserDiagnostics -e email1@domain.com
Creates an output file for containing contact related information for email1@domain.com. 
sudo ./clitool-acs.sh runUserDiagnostics -f /opt/Avaya/filelist.txt
Creates output files containing contact related information for every email specified in /opt/Avaya/filelist.txt. 
sudo ./clitool-acs.sh runUserDiagnostics -d email1@domain.com
Deregisters email1@domain.com and removes all data related to this user from Avaya Aura® Device Services. 
sudo ./clitool-acs.sh runUserDiagnostics -a
Checks the number of contacts in Session Manager and Avaya Aura® Device Services for all registered Avaya Aura® Device Services users and creates a file opt/Avaya/Contacts.xls.

Files

The following files are associated with the runUserDiagnostics tool:

  • opt/Avaya/DeviceServices/version/CAS/version/misc/clitool-acs.sh

  • /opt/Avaya/Contact.xls