AlteryxService Commands
Command
D:\Program Files\Alteryx\bin> .\AlteryxService.exe -help
Command Output
Command | Description |
|---|---|
?|help | Show this help message |
silent | Suppress default messages |
install | Installs the service with the O/S (requires admin) |
uninstall | Uninstalls the service with the O/S (requires admin) |
start | Starts the service |
stop | Stops the service |
test|testdebug | Runs the service interactively |
addtoqueue=path,host[:port],secret[,true] | 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 |
emongodump=path | Creates a MongoDB backup dump into the specified folder (requires admin) |
emongorestore=sourcepath,targetpath,[,batchsize] | Restores a MongoDB backup from "sourcePath" to "targetPath", use "batchsize" in low memory environments (requires admin) |
setemongopassword=password | Sets a new password for MongoDB. If the password field is empty, a randomly generated password is used (requires admin) |
setemongoadminpassword=password | Sets a new password for MongoDB. If the password field is empty, a randomly generated password is used (requires admin) |
getemongopassword[=host[:port],secret] | Returns Embedded MongoDB password (requires admin) |
getsecret|getserversecret | Returns the server secret (requires admin) |
getversion | Returns the current version of service |
runlocal=session_secret[,port] | Runs as current user using supplied secret (64-character hex) and optional port |
setexecuteuser=name,domain,password | Sets the execution user for Alteryx Engine (requires admin) |
setmongoconnectionworker=value | Sets the MongoDB connection string for a worker. Ensure that this is still the same database as your controller (requires admin) |
setmongoconnectioncontroller=value | Sets the MongoDB connection string for a controller (requires admin) |
setmongoconnectionserver=value | Sets the MongoDB connection string for the Server UI connection (requires admin) |
setsqlconnectionworker=value | Sets the SQL connection string for a worker. Ensure this is still the same database as your controller (requires admin) |
setsqlconnectioncontroller=value | Sets the SQL connection string for a controller (requires admin) |
setsqlconnectionserver=value | Sets the SQL connection string for the Server UI connection (requires admin) |
setmongopassword=value | Sets the MongoDB connection password (requires admin) |
setremotesecret=value | Sets the worker remote server secret (requires admin) |
setserversecret=value | Sets the controller server secret (requires admin) |
setsmtppassword=value | Sets the SMTP password for Server (requires admin) |
setsmtpclientsecret=value | Sets the SMTP Client Secret for Server (requires admin) |
setting=root,name,value | Overrides default setting with root "root" and name "name" with new value |
settingfile=path | Overrides default settings with contents of settings file from path "path" |
verifysettingfile=path[,outputpath] | Verifies settings from path "path", writes results to file or stdout |
transferdcmesecret[=ip|fqdn|hostname,secret] | Securely transfer DCME encryption key from existing environment |