How can I execute an MS SQLDebug.bat / MsSQLDebug.sh file?

How can I execute an MS SQLDebug.bat / MsSQLDebug.sh file?

The MsSQLDebug file is a diagnostic tool used to verify connectivity and discoverability of the MS SQL Server from the Applications Manager server. This standalone utility replicates the internal process used when adding an MS SQL Server monitor.

Steps to Execute:
  1. Open Command Prompt (or Terminal for .sh file).
  2. Navigate to the AppManager/bin/troubleshooting directory.
  3. Run the MsSQLDebug file using the following syntax:
Quote
Usage:
MsSQLDebug.bat [HostName/IP] [Port Number] [Authentication Type] [Username] [Password] [SSL Encryption (true/false)] [Instance Name]

Example: 
MsSQLDebug.bat 127.0.0.1 1433 SQL sa "User123" true SQLSERVER16
Notes
Note: Use MsSQLDebug.sh if you are on a Linux system.
Parameter Details:
  1. [HostName/IP] – Hostname or IP address of the machine where the MS SQL Server is running.
  2. [Port Number] – The port number used by the MS SQL Server (e.g., 1433).
  3. [Authentication] – Type of authentication used to connect to MS SQL. Accepted values: SQL or Windows.
  4. [Username] – Username for connecting to MS SQL. For Windows Authentication, format it as DomainName/UserName.
  5. [Password] – Password for connecting to MS SQL. If the password contains special characters, enclose it in double quotes ("pwd@123").
  6. [SSL Encryption] – Set to true if the SQL Server uses SSL/TLS for secure connections; otherwise, set to false.
  7. [Instance Name] – Specify the Named Instance of SQL Server if applicable. Leave it blank for default instances.
Usage for Kerberos Authentication:
Quote
MsSQLDebug.bat  [Database_FullyQualified_HostName] [Port Number] [Authentication] [Password] [Instance Name]
Parameter Details:
  1. [Database_FullyQualified_HostName] – Fully Qualified Domain Name (FQDN) of the MS SQL Server host. For example: mssql-test-1.mykerberos.com (where mssql-test-1 is the hostname and mykerberos.com is the domain).
  2. [Port Number] – Port number of the MS SQL Server. For Named Instances, a dummy port number can be used.
  3. [Authentication] – Must be specified as Kerberos.
  4. [Password] – Kerberos Principal password. Use null if ticketCache or keytab is configured for authentication.
  5. [Instance Name] – (Optional) Named instance of SQL Server. Leave it blank if not applicable.
Notes
Note: When connecting using a Named SQL Instance, you may enter a dummy port number in both the monitor configuration and the debug script. The actual resolution is handled internally via the SQL Server Browser service.
This process initiates the discovery of the MS SQL Server. If the connection is successful, it retrieves values for the default set of monitored attributes and displays them as output. This helps verify that the discovery was successful and that data is being collected for all attributes. If any attribute displays a null value, it indicates that the corresponding data is unavailable on the target server. In such cases, verify directly on the MS SQL Server that the required data exists and is accessible.
Info
  1. For more information or assistance, send us the output of the above command for analysis along with the Support Information File.
  2. Refer to our feature page to learn more about SQL Server monitoring in Applications Manager.