Database Credentials Tool
MetaDefender Managed File Transfer systems, integrated with a remote Microsoft SQL Server are prompted at install time to provide the login credentials (username and password), used for the connection with the database server.
For security compliance, some MetaDefender Managed File Transfer administrators may want to periodically update the login credentials of the Microsoft SQL Server.
The feature to update database credentials is only available for Managed File Transfer installations that use the recommended Microsoft SQL Server integration option at install time.
This feature is not available for Microsoft SQL Server Express LocalDB or Microsoft SQL Server - Windows Authentication.
How to use
To update your current login credentials, please follow these steps:
Make sure that the new Microsoft SQL Server account has the minimum required roles. The SQL Server login must be created with at least the dbcreator server role. The login must map to users for the master, sft_data and sft_conn databases. The users must have the db_owner role.
Open Command Prompt (cmd):
- Navigate to the Installation folder where the
SftDatabaseConfigurationTool.exefile is located. (e.g.: C:\Program Files\OPSWAT\MetaDefender Managed File Transfer\Tools)
- Navigate to the Installation folder where the
Open CmdRun the Tool with Arguments:
- Enter the following command structure:
SftDatabaseConfigurationTool.exe [--username <username_value> --password <password_value>] [--port <port_number>] [--encrypt] <true/false>
- Enter the following command structure:
SftDatabaseConfigurationTool command line arguments:
If
--usernameis set,--passwordis required, and vice versa.- Example:
--username admin --password pass123
- Example:
Specify a valid port number if required. It is optional, but if set, ensure it is a valid port number.
--port <port_number>- Example:
--port 1433
- Example:
Optionally enable encryption. If provided, it cannot be used alongside
--port:- Example:
--encrypt true
- Example:
When updating the database credentials, a new login account must be provided.
The new account must be different from the one currently in use.
This restriction is due to the fact that the current connection string will be rendered invalid if the current login's credentials are changed before initiating the update procedure in MetaDefender Managed File Transfer.
In order to only update the password of the existing login account, an intermediate login account must be created. This intermediate account is required in order to keep the connection with the database server up and running while the password is updated for the old login.
After the password of the first account is updated from SQL Server, the database credentials from MetaDefender Managed File Transfer can be updated again to the first login.
For other possible errors that might appear during the database credentials update procedure please check the opswat.mft.database.configuration.log file located in the Managed File Transfer install folder under the path Services\Logs.