Silent Install

Version:

2021.2

Last modified: May 17, 2021

Silent install is the installation of Alteryx Analytics Hub (AAH) that requires no user interaction. The config file for silent installation has to be a YML file saved as UTF-8 or UTF-16.

This is a basic command to install AAH silently from Command Prompt. It allows you to keep track of the silent installation. Until the installation completes, Command Prompt is not available.

cmd /c ANALYTICS_HUB_EXE /s CONFIG_FILE="..\Documents\SOME_FILE"

All Parameters

CONFIG_FILE - YML Config File Path
INSTALLATION_MODE - Mode of Installation (DEFAULT mode means Hub or WORKER mode)
PLATFORM_USERNAME - Username of Platform Admin User
PLATFORM_FIRSTNAME - First Name of Platform Admin User
PLATFORM_LASTNAME - Last Name of Platform Admin User
PLATFORM_EMAIL - Email of Platform Admin User
PLATFORM_PASSWORD - Password of Platform Admin User
POSTGRES_USERNAME - Username of Postgres User
POSTGRES_PASSWORD - Password of Postgres User
INSTALL_LOCATION - Destination Folder of Installation
STORAGE_TYPE - Binary Storage Type (FS_LOCAL or DB_POSTGRES)
PFX_CERTIFICATE_PATH - Path to PFX Certificate
CERTIFICATE_PASSWORD - PFX Certificate Password
AEP_HOST_NAME - Hub Host Name
AEP_PORT - Hub Port
CUTLASS_PORT - Engine Worker Cutlass(Alteryx Service) Port
CUTLASS_HOST_NAME - Engine Worker Cutlass Host Name
CA_PATH - CA Certificate Path
INSTALLER_KEY - Valid RSA Private Key for Engine Worker Node Authorization

Analytics Hub Installation

Required Parameters

PLATFORM_USERNAME
PLATFORM_FIRSTNAME
PLATFORM_LASTNAME
PLATFORM_EMAIL
PLATFORM_PASSWORD
POSTGRES_USERNAME
POSTGRES_PASSWORD

Default Parameters

INSTALL_LOCATION - "C:\Program Files\Alteryx"
INSTALLER_UI_LEVEL - 2 (silent mode)
STORAGE_TYPE - "FS_LOCAL"
INSTALLATION_MODE - "DEFAULT"

Example of AAH installation command that also creates log files:

.\AlteryxAnalyticsHubInstall.exe /s PLATFORM_USERNAME="example" PLATFORM_FIRSTNAME="example" PLATFORM_LASTNAME="example" PLATFORM_EMAIL="test@example.com" PLATFORM_PASSWORD="password" INSTALL_LOCATION="C:\Program Files\AlteryxTEST" POSTGRES_USERNAME="example" POSTGRES_PASSWORD=“example" -l "C:\Program Files\Alteryx\install logs\"

Example of AAH installation command with CONFIG_FILE and log location specified:
.\AlteryxAnalyticsHubInstall.exe /s CONFIG_FILE="C:\Program Files\config.yml" -l "C:\Program Files\Alteryx\install logs\"

CONFIG_FILE Example (YML file saved as UTF-8 or UTF-16)

---
INSTALL_LOCATION: D:\Alteryx
PLATFORM_USERNAME: platformadmin
PLATFORM_FIRSTNAME: platformadmin
PLATFORM_LASTNAME: hub
PLATFORM_EMAIL: aah@alteryx.com
PLATFORM_PASSWORD: admin
POSTGRES_USERNAME: postgresadmin
POSTGRES_PASSWORD: bestpassword
...

Engine Worker Installation

Required Parameters

INSTALLATION_MODE
PFX_CERTIFICATE_PATH
CERTIFICATE_PASSWORD
AEP_HOST_NAME
AEP_PORT
CUTLASS_PORT
CUTLASS_HOST_NAME
CA_PATH
INSTALLER_KEY

Default Parameters:

INSTALL_LOCATION - "C:\Program Files\Alteryx"
INSTALLER_UI_LEVEL - 2 (silent mode)

Example of worker installation command:
AlteryxAnalyticsHubInstall.exe /s PFX_CERTIFICATE_PATH=“C:\Users\Administrator\Desktop\cutlass.pfx” CERTIFICATE_PASSWORD=“YOUR_PASSWORD” AEP_HOST_NAME=“test.ayx-enterprise.com” AEP_PORT=“8080" CUTLASS_PORT=“5000” CUTLASS_HOST_NAME=“test.ayx-enterprise.com“ CA_PATH=“C:\Users\Administrator\Desktop\CAroot.crt” INSTALLATION_MODE=“WORKER” INSTALL_LOCATION=“C:\Program Files\Alteryx” INSTALLER_KEY=valid rsa private key

Example of worker installation command with CONFIG_FILE specified.
.\AlteryxAnalyticsHubInstall.exe /s CONFIG_FILE="C:\Program Files\config.yml"

CONFIG_FILE example (YML file saved as UTF-8 or UTF-16):

---
PFX_CERTIFICATE_PATH: C:\Users\Administrator\Desktop\cutlass.pfx
CERTIFICATE_PASSWORD: password
AEP_HOST_NAME: testhub.ayx-enterprise.com
AEP_PORT: 8080
CUTLASS_HOST_NAME: workerInstance.ayx-enterprise.com
CUTLASS_PORT: 5000
CA_PATH: C:\Users\Administrator\Desktop\CAroot.crt
INSTALLATION_MODE: worker 
INSTALLER_KEY: valid rsa private key
...