AlteryxService Commands

Version:
2019.3
Last modified: May 27, 2020
Bash
  1. D:\Program Files\Alteryx\bin> .\AlteryxService.exe -help
  2. #Show this help message
  3. ?|help
  4. #Suppress default messages                                     
  5. silent 
  6.  
  7.  #Installs the service with the O/S (requires admin)                                    
  8. install 
  9.  
  10. #Uninstalls the service with the O/S (requires admin)                                  
  11. uninstall  
  12.  
  13. # Starts the service (requires admin)                                
  14. start  
  15.  
  16. # Stops the service (requires admin)                                   
  17. stop     
  18.  
  19. # Runs the service interactively                                  
  20. test|testdebug 
  21.  
  22. # Queues workflow from path "path" to run from disk, add 'true' to run from db                      
  23. addtoqueue=path,host[:port],secret[,true]  
  24. #Example: C:\Program Files\Alteryx\bin\AlteryxService.exe addtoqueue=C:\Temp\simpleoutput.yxmd,localhost,3EA75D9170E4956DC3583C23224B0898A98376D,true
  25.  
  26. #Creates a mongo backup dump into the specified folder (requires admin)
  27. emongodump=path
  28. #Example: C:\Program File\Alteryx\bin\AlteryxService.exe emongodump=c:\temp\mongo_dump
  29.  
  30. #Restores a mongo backup from "sourcePath" to "targetPath" (requires admin)                   
  31. emongorestore=sourcepath,targetpath 
  32. #Example: C:\Program Files\Alteryx\bin\AlteryxService.exe emongorestore=”c:\Temp\mongo_dump”,”C:\programdata\alteryx\service\persistance”
  33.  
  34. #Sets a new password for mongo. If the password field is empty a randomly generated password will be used. (requires admin)       
  35. setemongopassword=password
  36.  
  37. #Sets a new password for mongo. If the password field is empty a randomly generated password will be used. (requires admin)                 
  38. setemongoadminpassword=password  
  39.  
  40. #Returns Embedded Mongo password (requires admin)         
  41. getemongopassword[=host[:port],secret] 
  42.  
  43. #Returns the server secret (requires admin)
  44. getsecret|getserversecret   
  45.  
  46. #Returns the current version of service
  47. getversion    
  48.  
  49. #Runs as current user using supplied secret (40-character hex) and optional port      
  50. runlocal=session_secret[,port] 
  51.  
  52. #Sets the execution user for Alteryx Engine (requires admin)           
  53. setexecuteuser=name,domain,password 
  54.  
  55. #Sets the Mongo connection password (requires admin)      
  56. setmongopassword=value 
  57.  
  58. #Sets the worker remote server secret (requires admin)                    
  59. setremotesecret=value 
  60.  
  61. #Sets the master server secret (requires admin)  - New value must be exactly 40 characters                 
  62. setserversecret=value
  63. #Example: C:\Program Files\Alteryx\bin\AlteryxService.exe setserversecret= 5A67FCF92F11369287D2A354FBC0A1ED129DBF3A
  64.  
  65. #Sets the SMTP password for Gallery (requires admin)                      
  66. setsmtppassword=value
  67.  
  68. #Overrides default setting with root "root" and name "name" with new value - For use with Test command
  69. setting=root,name,value
  70. #Example: C:\Program Files\Alteryx\bin\AlteryxService.exe test setting=Controller,EmbeddedMongoDBLogPath,"C:\Temp\mongo.txt"
  71.  
  72. #Overrides default settings with contents of settings file from path "path"                    
  73. settingfile=path
  74.  
  75. #Verifies settings from path "path", writes results to file or stdout                           
  76. verifysettingfile=path[,outputpath]        
Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.