PSAYX

1.1.0

Public/Installation/Install-Server.ps1

function Install-Server {
    <#
        .SYNOPSIS
        Install Alteryx Server

        .DESCRIPTION
        Configure and install Alteryx Server via command-line

        .NOTES
        File name: Install-Server.ps1
        Author: Florian Carrier
        Creation date: 2021-06-10
        Last modified: 2024-09-17

        .LINK
        https://www.powershellgallery.com/packages/PSAYX

        .LINK
        https://help.alteryx.com/product-activation-and-licensing/use-command-line-options
    #>
    [CmdletBinding (
        SupportsShouldProcess = $true
    )]
    # Inputs
    Param (
        [Parameter (
            Position    = 1,
            Mandatory   = $true,
            HelpMessage = "Path to Alteryx Server installer"
        )]
        [ValidateNotNullOrEmpty ()]
        [System.IO.FileInfo]
        $Path,
        [Parameter (
            Position    = 2,
            Mandatory   = $false,
            HelpMessage = "Target installation path"
        )]
        [ValidateNotNullOrEmpty ()]
        [String]
        $InstallDirectory,
        [Parameter (
            Position    = 3,
            Mandatory   = $false,
            HelpMessage = "Installation log file path"
        )]
        [ValidateNotNullOrEmpty ()]
        [String]
        $Log,
        [Parameter (
            Position    = 4,
            Mandatory   = $false,
            HelpMessage = "Serial number (email address)"
        )]
        [ValidateNotNullOrEmpty ()]
        [Alias ("Email")]
        [String]
        $Serial,
        [Parameter (
            Position    = 5,
            Mandatory   = $false,
            HelpMessage = "Language of the install"
        )]
        [ValidateSet (
            "Deutsch",
            "English",
            "Español",
            "Français",
            "Japanese",
            "Português"
        )]
        [Alias ("Locale")]
        [String]
        $Language,
        [Parameter (
            Position    = 6,
            Mandatory   = $false,
            HelpMessage = "Version to install"
        )]
        [String]
        $Version,
        [Parameter (
            HelpMessage = "Switch to install for all users"
        )]
        [Switch]
        $AllUsers,
        [Parameter (
            HelpMessage = "Switch to suppress all dialogs"
        )]
        [Switch]
        $Unattended,
        [Parameter (
            HelpMessage = "Switch to suppress non-critical messages"
        )]
        [Switch]
        $Silent
    )
    Begin {
        # Get global preference variables
        Get-CallerPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState
        # Check installer
        if (-Not (Test-Path -Path $Path)) {
            Write-Log -Type "ERROR" -Message "Path not found $Path"
            Write-Log -Type "ERROR" -Message "Alteryx Server installer cannot be located" -ErrorCode 1
        }
        # Define install parameters
        $Parameters = [System.Collections.ArrayList]::New()
        # Custom installation directory
        if ($PSBoundParameters.ContainsKey("InstallDirectory")) {
            if (-Not (Test-Path -Path $InstallDirectory)) {
                New-Item -Name $InstallDirectory -ItemType "Directory"
            }
        }
    }
    Process {
        # TODO Check for previous installation
        # Check version to account for legacy installer command-line parameters
        if ($PSBoundParameters.ContainsKey("Version") -And (Compare-Version -Version $Version -Operator "lt" -Reference "2022.3")) {
            # Custom installation directory
            if ($PSBoundParameters.ContainsKey("InstallDirectory")) {
                [Void]$Parameters.Add("TARGETDIR=""$InstallDirectory""")
            }
            # Logs
            if ($PSBoundParameters.ContainsKey("Log")) {
                [Void]$Parameters.Add("/l=""$Log""")
            }
            # Serial
            if ($PSBoundParameters.ContainsKey("Serial")) {
                [Void]$Parameters.Add("SERIAL_NUM=""$Serial""")
            }
            # Language
            if ($PSBoundParameters.ContainsKey("Language")) {
                [Void]$Parameters.Add("CMD_LANGUAGE=""$Language""")
            }
            # System installation
            if ($AllUsers -eq $true) {
                [Void]$Parameters.Add("ALLUSERS=""TRUE""")
            } else {
                [Void]$Parameters.Add("ALLUSERS=""FALSE""")
            }
            # Installation
            [Void]$Parameters.Add("REMOVE=""FALSE""")
            # Silent switch
            if ($Unattended -eq $true) {
                [Void]$Parameters.Add("/s")
            }
        } else {
            # Custom installation directory
            if ($PSBoundParameters.ContainsKey("InstallDirectory")) {
                [Void]$Parameters.Add("-d ""$InstallDirectory""")
            }
            # Logs
            if ($PSBoundParameters.ContainsKey("Log")) {
                [Void]$Parameters.Add("-l ""$Log""")
                # MSI log file
                # [Void]$Parameters.Add("-m ""$Log""")
            }
            # Silent switch
            if ($Unattended -eq $true) {
                [Void]$Parameters.Add("-s")
            }
        }
        # Build argument list and command for debug
        $Arguments = $Parameters -join " "
        $Command = ("&", """$Path""", $Arguments) -join " "
        Write-Log -Type "DEBUG" -Message $Command
        # Call installer and return process
        if ($PSCmdlet.ShouldProcess($Path, "Install")) {
            $Process = Start-Process -FilePath $Path -ArgumentList $Arguments -Verb "RunAs" -PassThru -Wait
        } else {
            # Return dummy process
            $Process = New-Object -TypeName "System.Diagnostics.Process"
        }
        return $Process
    }
}