Manage Settings from the Command Line

Version:
Current
Last modified: March 24, 2021

Another way to manage settings is with the ayxhub.ps1 script. To run the script, open Windows PowerShell as an admin and execute&"C:\Program Files\Alteryx\Alteryx Analytics Hub\ayxhub.ps1"
 

Some of the Available Commands

-list

List the current configuration. Shows changes that are pending since the latest Alteryx Analytics Hub restart.
 

-port

Specify the localhost port on which the application listens.

-https generate-selfsigned [location] [hostname]

Generate self-signed certificate in a specified or default location issued to the specified hostname or localhost if hostname is not defined.
 

-https enable <cert-file> <key-file>

Enable https by specifying the certificate and key locations.
 

-https disable

Disables https.

-db postgres <username> <password>

Set the credentials used to connect to the database.
 

-jwt_secret generate

Generate a new JWT secret. This ends all existing user sessions.
 

-start

Start Alteryx Analytics Hub.

-stop

Stops Analytics Hub frontend, backend, and engine worker services gracefully. It does not stop the licensing or Postgres services. 

-stop force

Stop Alteryx Analytics Hub immediately.
 

-restart

Restart Alteryx Analytics Hub [stops gracefully].

-pending remove

Remove any pending changes and revert back to previous configuration.
-add-platform-admin <first-name> <last-name> <username> <email> <password> Add a Platform Admin.
Script running in PowerShell

Screenshot of PowerShell script

Was This Page Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.