AlteryxService Commands
Command
D:\Program Files\Alteryx\bin> .\AlteryxService.exe -help
Command Output
#Show this help message
?|help
#Suppress default messages
silent
#Installs the service with the O/S (requires admin)
install
#Uninstalls the service with the O/S (requires admin)
uninstall
#Starts the service (requires admin)
start
#Stops the service (requires admin)
stop
#Runs the service interactively
test|testdebug
#Not supported on Alteryx Server. This command is for the desktop scheduler only. #Queues workflow from path "path" to run from disk, add 'true' to run from db
addtoqueue=path,host[:port],secret[,true]
#Creates a MongoDB backup dump into the specified folder (requires admin)
emongodump=path
#Restores a MongoDB backup from "sourcePath" to "targetPath" (requires admin)
emongorestore=sourcepath,targetpath
#Sets a new password for MongoDB. If the password field is empty a password is generated. (requires admin)
setemongopassword=password
#Sets a new password for MongoDB. If the password field is empty password is generated. (requires admin)
setemongoadminpassword=password
#Returns Embedded MongoDB password (requires admin)
getemongopassword[=host[:port],secret]
#Returns the server secret (requires admin)
getsecret|getserversecret
#Returns the current version of service
getversion
#Runs as current user using supplied secret (40-character hex) and optional port
runlocal=session_secret[,port]
#Sets the execution user for Alteryx Engine (requires admin)
setexecuteuser=name,domain,password
#Sets the MongoDB connection password (requires admin)
setmongopassword=value
#Sets the worker remote server secret (requires admin)
setremotesecret=value
#Sets the master server secret (requires admin)
setserversecret=value
#Sets the SMTP password for Server (requires admin)
setsmtppassword=value
#Overrides default setting with root "root" and name "name" with new value
setting=root,name,value
#Overrides default settings with contents of settings file from path "path"
settingfile=path
#Verifies settings from path "path", writes results to file or stdout
verifysettingfile=path[,outputpath]
#Sets the MongoDB connection string for the Server UI connection (requires admin)
setmongoconnectionserver
#Sets the MongoDB connection string for a worker. Ensure that this is still the same database as your controller (requires admin)
setmongoconnectionworker
#Sets the MongoDB connection string for a controller (requires admin)
setmongoconnectioncontroller