What if I am unable to log in and getting “SCRAM-SHA-256” errors in my SDApiService.log file?

Where Is the Log Located?

By default, the SDApiService.log file is located at:
C:\SmartDeploy\Logs\SDApiService.log

If the file is not found in that location or the timestamp is not recent, check the SmartDeploy folder where your images are stored for a copy.

What Would the Error Look Like in Your Log?

An example of the error message you might see:

Fatal Service failed to start. One or more errors occurred. (Unable to authenticate using SASL protocol mechanism SCRAM-SHA-256.)
MongoDB.Driver.MongoAuthenticationException: Unable to authenticate using SASL protocol mechanism SCRAM-SHA-256.

What Generally Causes This Issue?

SmartDeploy uses the endpoint ID of the console machine to authenticate with the local MongoDB database.

When a virtual machine (VM) is moved or its platform changes, this endpoint ID may also change due to differences in the underlying hardware. These changes can cause authentication failures when SmartDeploy attempts to connect to MongoDB.

Solution

This issue can be resolved by disabling authentication on the local MongoDB database.
Doing so removes the dependency on the endpoint ID for authentication.

A PowerShell script is included in this article to help resolve the problem.

1. Download the script: MongoFixOptions.ps1

2. Save it in a convenient location.

3. Run the script as an Administrator.

If the script runs successfully, a list of available options will appear.

Select Option 6 – Toggle Mongo & Console Authentication
This option enables or disables authentication in SmartDeploy’s MongoDB connection string.

To run the script from an elevated Command Prompt, use the following commands:

powershell -executionpolicy bypass -file (filepath of PowerShell file)

An example of this, if the downloaded PowerShell script (MongoFixOptions.ps1) is located in C:\temp, would be:

powershell -executionpolicy bypass -file "C:\temp\MongoFixOptions.ps1"

If issue is not resolved, please collect the logs below and create a ticket with the logs attached.

'C:\SmartDeploy\Logs\SDConsole.log' and 'C:SmartDeploy\Logs\SDApiService.log'

(Please note that it may be different drive than the C:\ drive.)

Download the Script here: