AlteryxService Commands

Version:
2019.4
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.  
  25. #Creates a mongo backup dump into the specified folder (requires admin)
  26. emongodump=path
  27.  
  28. #Restores a mongo backup from "sourcePath" to "targetPath" (requires admin)                   
  29. emongorestore=sourcepath,targetpath 
  30.  
  31. #Sets a new password for mongo. If the password field is empty a randomly generated password will be used. (requires admin)       
  32. setemongopassword=password
  33.  
  34. #Sets a new password for mongo. If the password field is empty a randomly generated password will be used. (requires admin)                 
  35. setemongoadminpassword=password  
  36.  
  37. #Returns Embedded Mongo password (requires admin)         
  38. getemongopassword[=host[:port],secret] 
  39.  
  40. #Returns the server secret (requires admin)
  41. getsecret|getserversecret   
  42.  
  43. #Returns the current version of service
  44. getversion    
  45.  
  46. #Runs as current user using supplied secret (40-character hex) and optional port      
  47. runlocal=session_secret[,port] 
  48.  
  49. #Sets the execution user for Alteryx Engine (requires admin)           
  50. setexecuteuser=name,domain,password 
  51.  
  52. #Sets the Mongo connection password (requires admin)      
  53. setmongopassword=value 
  54.  
  55. #Sets the worker remote server secret (requires admin)                    
  56. setremotesecret=value 
  57.  
  58. #Sets the master server secret (requires admin)                     
  59. setserversecret=value
  60.  
  61. #Sets the SMTP password for Gallery (requires admin)                      
  62. setsmtppassword=value
  63.  
  64. #Overrides default setting with root "root" and name "name" with new value                      
  65. setting=root,name,value
  66.  
  67. #Overrides default settings with contents of settings file from path "path"                    
  68. settingfile=path
  69.  
  70. #Verifies settings from path "path", writes results to file or stdout                           
  71. verifysettingfile=path[,outputpath]        
Was This Helpful?

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