Back up/restore configuration
To back up or restore Adaxes service configuration:
-
Navigate to the folder where Adaxes service is installed. By default, the folder is C:\Program Files\Softerra\Adaxes 3\Service.
-
Launch the Softerra.Adaxes.BackupRestore.exe tool.
-
Follow the instructions in the wizard.
From Adaxes 2018.1 onwards, the configuration of Adaxes Web interface is included into the service configuration backup file.
For Adaxes 2017.2 and older, the configuration of the Web interface has to be backed up separately:
-
Navigate to the folder where Adaxes Web interface is installed. By default, the folder is C:\Program Files\Softerra\Adaxes 3\Web Interface.
-
Launch the Softerra.Adaxes.Web.UI.Configuration.exe tool.
-
Click Back Up Configuration and follow the instructions in the wizard.
Back up/restore configuration via command line
To back up or restore the configuration via command line, use the Softerra.Adaxes.BackupRestore.exe tool located in the folder where Adaxes service is installed, which is C:\Program Files\Softerra\Adaxes 3\Service by default.
Parameters
| Command | Parameters | Description |
|---|---|---|
| /b|backup | <backup-file-path> | Specifies the path to the backup file to be created. The parameter is required. |
| -l <log-file-path> | Specifies the path to the file that will contain log information about the backup process. The parameter is optional. | |
| -u|user <username> <password> | Specifies the credentials of the Adaxes service account. | |
| -backupCredentials | If the parameter is specified, the credentials used by the Adaxes service (e.g. for managed domains, Microsoft 365 tenants, etc.) will be included into the backup. Warning: The credentials will be stored in the backup using a weak encryption algorithm. If the parameter is omitted, you will need to specify the credentials manually after restoring Adaxes configuration. |
|
| /r|restore | <path-to-file> | Specifies the path to the backup file from which to restore configuration. The parameter is required. |
| -l <path-to-log-file> | Specifies the path to the file that will contain log information about the restore process. The parameter is optional. | |
| -u|user <username> <password> | Specifies the credentials of the Adaxes service account. | |
| -rap|restoreApprovalRequests | If the parameter is specified, approval requests will be restored from the backup. | |
| /help|h|? | Shows usage information. |
Examples
Example 1 – Back up Adaxes configuration
Softerra.Adaxes.BackupRestore.exe /b C:\Adaxes.bak -l C:\AdaxesBackup.log -u DOMAIN\Administrator secret
Example 2 – Restore Adaxes configuration
Softerra.Adaxes.BackupRestore.exe /r C:\Adaxes.bak -l C:\AdaxesBackup.log -u DOMAIN\Administrator secret