DCME Keys to Backup
This guide is intended to assist a Server administrator with proactively preparing for the DCME Master key recovery in the event of failure of an original host or hosts, when moving to a new upgraded Server, moving from an on-premises to a cloud Server, and in other cases where your infrastructure changes.
A DCME Master key recovery allows you to run workflows which are associated with DCME credentials.
Prerequisites
Access to the original controller/host machine.
Ready with new Alteryx Server system.
Restore the MongoDB Backup (Host Recovery Process) on the original system. For more information, visit the Server Host Recovery Guide.
System Administrator rights on the new and original Server.
Access to all shared credentials used for running workflows including, the service account (if not Local System), the Run As user, and any defined/used workflow credentials.
Controller Token from the original Server and port number if different than the default port.
Alteryx Service must be running on the original machine.
Step 1: Know the Original Host Details
# | Step | Details |
|---|---|---|
1.1 | Get Working Machine Controller Token | Copy Controller Token from Alteryx System Settings > Controller section or C:\Program Files\Alteryx\bin>.\AlteryxService.exe getserversecret |
1.2 | Get Working Machine Host Details | Non-TLS Enabled: Get IP address or FQDN or Hostname of the working machine and port number if any, other than default port. TLS Enabled: Get IP address or FQDN of the working machine and port number if any, other than default port. |
Step 2: Know New AlteryxService Host Details
# | Step | Details |
|---|---|---|
2.1 | Get AlteryxService.exe Path | C:\Program Files\Alteryx\> .\AlteryxService.exe |
Step 3: Prepare and Execute Command
# | Step | Details |
|---|---|---|
3.1 | Command | transferdcmesecret |
3.2 | Prepare Command | Non-TLS Enabled With default port: C:\Program Files\Alteryx\>.\AlteryxService.exe transferdcmesecret=<IP Address | Hostname | FQDN><port number>,<Unencrypted Controller Token> Note: Port number is optional for default. Example: C:\Program Files\Alteryx\bin>.\AlteryxService.exe transferdcmesecret=172.x.2x.2xx,81d73a13f264c4b5b43d6e28e9419dc8861d1091ffc46f23f5afaabaaaaab With specified port number: C:\Program Files\Alteryx\bin>.\AlteryxService.exe transferdcmesecret=<IP Address | Hostname | FQDN>:<port number>:<Unencrypted Controller Token> Example: C:\Program Files\Alteryx\bin>.\AlteryxService.exe transferdcmesecret=172.x.2x.2xx:81,81d73a13f264c4b5b43d6e28e9419dc8861d1091ffc46f23f5afaabaaaaab TLS Enabled With default port: C:\Program Files\Alteryx\bin>.\AlteryxService.exe transferdcmesecret=<https://IP Address | FQDN>:<optional port number>:<Unencrypted Controller Token> Note: Port number is optional for default. It is mandatory for non-default. Example: C:\Program Files\Alteryx\bin>.\AlteryxService.exe transferdcmesecret=https://172.x.2x.2xx,81d73a13f264c4b5b43d6e28e9419dc8861d1091ffc46f23f5afaabaaaaab With specified port number: C:\Program Files\Alteryx\bin>.\AlteryxService.exe transferdcmesecret=<https://IP Address | FQDN>:<port number>,<Unencrypted Controller Token> Example: C:\Program Files\Alteryx\bin>.\AlteryxService.exe transferdcmesecret=https://172.x.2x.2xx:443,81d73a13f264c4b5b43d6e28e9419dc8861d1091ffc46f23f5afaabaaaaab |
3.3 | Execute the Command | Open PowerShell window in admin mode and run the command from step 2.1. |
Note
If you see any error logs on the console window, please make necessary actions according to the Known Error Messages table and re-run the command.
Known Error Messages
Error Message | Cause |
|---|---|
Invalid parameters. Could not retrieve original key. | Incorrect Controller Token from Original host. |
Failed to get server address, server <servername>: No such host is known. | Incorrect or communication issues with specified IP Address/Hostname/FQDN. |
Failed to connect to server <servername>, port <xxxx>: No connection could be made because the target machine actively refused it. | Incorrect port number. |
Step 4: Run Alteryx Service After DCME Key Transfer
# | Step | Details |
|---|---|---|
4.1 | Restart Alteryx Service | Go to Task Manager > Service, select Alteryx Service and then select Restart. |