install_utils.ps1

$ZAPPLIANCE_PASSWORD_OVF_PROPERTY_NAME = "ZertoAdminPassword"
$ZERTO_SECURE_FOLDER = "avs-zerto"

function Get-ZertoOVAFile {
    param (
        [Parameter(Mandatory = $true, HelpMessage = "MyZerto Token")]
        [string]$MyZertoToken
    )

    process {
        $LocalFolderPath = Get-Location

        try {
            Write-Host "Getting Zerto download links"
            $ZertoUrlsJson = Get-ZertoDownloadLinksFromMyZerto -Token $MyZertoToken

            Write-Host "Parsing download links"
            $OvaPresignedUrl = $ZertoUrlsJson.data.files.ova_file
            $OvaSignaturePresignedUrl = $ZertoUrlsJson.data.files.ova_signature

            $OvaFileName = Get-FileNameFromDownloadLink -Url $OvaPresignedUrl
            $OvaSignatureFileName = Get-FileNameFromDownloadLink -Url $OvaSignaturePresignedUrl

            $OvaFilePath = Join-Path -Path "$LocalFolderPath" -ChildPath "$OvaFileName"
            $OvaSignatureFilePath = Join-Path -Path "$LocalFolderPath" -ChildPath "$OvaSignatureFileName"

            Write-Host "Downloading OVA file $OvaFileName"
            Write-Host "The download might take a while, please wait..."
            Download-File -FileUrl $OvaPresignedUrl -LocalFilePath $OvaFilePath

            Write-Host "Downloading OVA signature file $OvaSignatureFileName"
            Download-File -FileUrl $OvaSignaturePresignedUrl -LocalFilePath $OvaSignatureFilePath
        }
        catch {
            Write-Error "Failed to download Zerto OVA files, exception = $_" -ErrorAction Stop
        }

        if ((Validate-FileBySignature -FilePath $OvaFilePath -SignatureFilePath $OvaSignatureFilePath) -ne $true) {
            Write-Error "OVA signature validation failed." -ErrorAction Stop
        }

        return $OvaFilePath
    }
}

function Get-ZertoDownloadLinksFromMyZerto {
    param (
        [Parameter(Mandatory = $true, HelpMessage = "My Zerto Zoken")]
        [string]$Token
    )

    process {

        Write-Host "Starting $($MyInvocation.MyCommand)"

        try {
            $Url = "https://www.zerto.com/myzerto/wp-json/services/zerto/s3-ova?key=" + $Token
            $Response = Invoke-WebRequest -Uri $Url -SkipCertificateCheck -ErrorAction Stop -TimeoutSec 1800 | ConvertFrom-Json
        }
        catch {
            $ErrorMessage = $_

            if ($ErrorMessage -match "invalid_key") {
                Write-Error "Failed to receive download links for the ZVM Appliance. Invalid token" -ErrorAction Stop
            }
            else {
                Write-Host $ErrorMessage
                Write-Error "Failed to receive download links for the ZVM Appliance" -ErrorAction Stop
            }
        }

        Write-Host "Zerto download links JSON received successfully"

        return $Response
    }
}

function Download-File {
    param (
        [Parameter(Mandatory = $true, HelpMessage = "file url to download from")]
        [string]$FileUrl,
        [Parameter(Mandatory = $true, HelpMessage = "local file path")]
        [string]$LocalFilePath
    )

    process {

        Write-Host "Starting $($MyInvocation.MyCommand)"

        if (Test-Path "$LocalFilePath") {
            Write-Host "$LocalFilePath already exists. Skipping download"
            return
        }

        try {
            $start_time = Get-Date

            Invoke-WebRequest $FileUrl -OutFile $LocalFilePath -ErrorAction Stop -TimeoutSec 10800 -Resume -SkipCertificateCheck
        }
        catch {
            Write-Error "Failed to download $FileUrl, exception = $_" -ErrorAction Stop
        }

        Write-Host "Download completed successfully, duration: $((Get-Date).Subtract($start_time).TotalSeconds.ToString("F0")) seconds."
    }
}

function Get-FileNameFromDownloadLink {
    param (
        [Parameter(Mandatory = $true, HelpMessage = "file url to download from")]
        [string]
        $Url
    )

    process {
        try {
            $uri = New-Object System.Uri($url)
            $FileName = [System.IO.Path]::GetFileName($uri.LocalPath)
            return $FileName
        }
        catch {
            throw "Failed getting file name from $Url, exception = $_"
        }
    }
}

function Deploy-Vm {
    param(
        [Parameter(Mandatory = $true, HelpMessage = "Path for the OVA file")]
        [ValidateNotNullOrEmpty()][string]
        $OvaPath,

        [Parameter(Mandatory = $true, HelpMessage = "Host Name")]
        [ValidateNotNullOrEmpty()][string]
        $VMHostName,

        [Parameter(Mandatory = $true, HelpMessage = "Datastore Name")]
        [ValidateNotNullOrEmpty()][string]
        $DatastoreName,

        [Parameter(Mandatory = $true, HelpMessage = "Zvm IP address")]
        [ValidateNotNullOrEmpty()][string]
        $ZVMLIp,

        [Parameter(Mandatory = $true, HelpMessage = "Network name for ZVML")]
        [ValidateNotNullOrEmpty()][string]
        $NetworkName,

        [Parameter(Mandatory = $true, HelpMessage = "SubnetMask address")]
        [ValidateNotNullOrEmpty()][string]
        $SubnetMask,

        [Parameter(Mandatory = $true, HelpMessage = "Default gateway")]
        [ValidateNotNullOrEmpty()][string]
        $DefaultGateway,

        [Parameter(Mandatory = $true, HelpMessage = "DNS server address")]
        [ValidateNotNullOrEmpty()][string]
        $DNS,

        [Parameter(Mandatory = $true, HelpMessage = "Azure Tenant Id, Globally unique identifier, found in Azure portal")]
        [ValidateNotNullOrEmpty()][string]
        $AzureTenantId,

        [Parameter(Mandatory = $true, HelpMessage = "Azure Client ID - Application ID, found in Azure portal")]
        [ValidateNotNullOrEmpty()][string]
        $AzureClientID,

        [Parameter(Mandatory = $true, HelpMessage = "The ID of the target subscription")]
        [ValidateNotNullOrEmpty()][string]
        $AvsSubscriptionId,

        [Parameter(Mandatory = $true, HelpMessage = "AVS resources that are all in the same AVS Region")]
        [ValidateNotNullOrEmpty()][string]
        $AvsResourceGroup,

        [Parameter(Mandatory = $true, HelpMessage = "Private cloud name")]
        [ValidateNotNullOrEmpty()][string]
        $AvsCloudName
    )

    process {

        try {
            Write-Host "Starting $($MyInvocation.MyCommand)"

            $ovfConfig = Set-OvfProperties -OvaPath $OvaPath -ZVMLIp $ZVMLIp -NetworkName $NetworkName -SubnetMask $SubnetMask -DefaultGateway $DefaultGateway -DNS $DNS

            $datastore = Get-Datastore -Name $DatastoreName

            $vmHost = Get-VMHost -Name $VMHostName

            Write-Host "The deployment process might take a while, please wait..."
            $start_time = Get-Date
            $secure_folder = [AVSSecureFolder]::GetOrCreate($ZERTO_SECURE_FOLDER)
            Import-VApp -Source $OvaPath -OvfConfiguration $ovfConfig -Name $ZVM_VM_NAME -VMHost $vmHost -InventoryLocation $secure_folder -Datastore $datastore -ErrorAction stop | Out-Null
            [AVSSecureFolder]::Secure($secure_folder)
            Write-Host "$ZVM_VM_NAME was deployed successfully, duration: $((Get-Date).Subtract($start_time).TotalSeconds.ToString("F0")) seconds."

            Set-Platform-OvfProperties -AzureTenantId $AzureTenantId -AzureClientID $AzureClientID -AvsSubscriptionId $AvsSubscriptionId -AvsResourceGroup $AvsResourceGroup -AvsCloudName $AvsCloudName
        }
        catch {
            Write-Error "Failed to deploy $ZVM_VM_NAME ZVML, exception = $_" -ErrorAction Stop
        }

    }
}

function Set-Platform-OvfProperties {
    param(
        [Parameter(Mandatory = $true, HelpMessage = "Azure Tenant Id, Globally unique identifier, found in Azure portal")]
        [ValidateNotNullOrEmpty()][string]
        $AzureTenantId,

        [Parameter(Mandatory = $true, HelpMessage = "Azure Client ID - Application ID, found in Azure portal")]
        [ValidateNotNullOrEmpty()][string]
        $AzureClientID,

        [Parameter(Mandatory = $true, HelpMessage = "The ID of the target subscription")]
        [ValidateNotNullOrEmpty()][string]
        $AvsSubscriptionId,

        [Parameter(Mandatory = $true, HelpMessage = "AVS resources that are all in the same AVS Region")]
        [ValidateNotNullOrEmpty()][string]
        $AvsResourceGroup,

        [Parameter(Mandatory = $true, HelpMessage = "Private cloud name")]
        [ValidateNotNullOrEmpty()][string]
        $AvsCloudName
    )
    process {

        Write-Host "Starting $($MyInvocation.MyCommand)..."

        try {
            $ZVM = Get-VM -Name $ZVM_VM_NAME
            if ($null -eq $ZVM) {
                Write-Error "$ZVM_VM_NAME does not exist" -ErrorAction Stop
            }
            else {
                $vappProperties = $ZVM.ExtensionData.Config.VAppConfig.Property
                # Create a new Update spec based on the # of OVF properties to update
                $spec = New-Object VMware.Vim.VirtualMachineConfigSpec
                $spec.vAppConfig = New-Object VMware.Vim.VmConfigSpec
                $propertySpec = New-Object VMware.Vim.VAppPropertySpec[](10)

                #Starting from, the last property Key of VM. Otherwise, we will override existing properties
                $array = $vappProperties | Sort-Object -Property Key -Descending
                $propertyKey = $array[0].Key + 1

                # AVS properties
                $AzureTenantIdProperty = Create-OvfProperty ([ref]$propertyKey) -PropertyValue $AzureTenantId -PropertyId "AzureTenantId" -PropertyType "string" -Operation "add"
                $propertySpec += ($AzureTenantIdProperty)
                $AzureClientIDProperty = Create-OvfProperty ([ref]$propertyKey) -PropertyValue $AzureClientID -PropertyId "AzureClientID" -PropertyType "string" -Operation "add"
                $propertySpec += ($AzureClientIDProperty)
                # TODO: Pavlo, is this working?
                $AvsSubscriptionIdProperty = Create-OvfProperty ([ref]$propertyKey) -PropertyValue $AvsSubscriptionId -PropertyId "AvsSubscriptionId" -PropertyType "string" -Operation "add"
                $propertySpec += ($AvsSubscriptionIdProperty)
                $AvsAvsResourceGroupProperty = Create-OvfProperty ([ref]$propertyKey) -PropertyValue $AvsResourceGroup -PropertyId "AvsResourceGroup" -PropertyType "string" -Operation "add"
                $propertySpec += ($AvsAvsResourceGroupProperty)
                $AvsCloudNameProperty = Create-OvfProperty ([ref]$propertyKey) -PropertyValue $AvsCloudName -PropertyId "AvsCloudName" -PropertyType "string" -Operation "add"
                $propertySpec += ($AvsCloudNameProperty)
                Write-Host "Added AVS properties to ZVM"

                #VC Properties
                $ZertoUserWithDomain = "$ZERTO_USER_NAME@$DOMAIN"
                $VcUserProperty = Create-OvfProperty ([ref]$propertyKey) -PropertyValue $ZertoUserWithDomain -PropertyId "VcUsername" -PropertyType "string" -Operation "add"
                $propertySpec += ($VcUserProperty)
                $VcIpProperty = Create-OvfProperty ([ref]$propertyKey) -PropertyValue $VC_ADDRESS -PropertyId "VcIp" -PropertyType "string" -Operation "add"
                $propertySpec += ($VcIpProperty)
                Write-Host "Added VC properties to ZVM"

                #ZVM Properties
                $ZertoAdminProperty = Create-OvfProperty ([ref]$propertyKey) -PropertyValue $PersistentSecrets.ZertoAdminPassword -PropertyId $ZAPPLIANCE_PASSWORD_OVF_PROPERTY_NAME -PropertyType "password" -Operation "add"
                $propertySpec += ($ZertoAdminProperty)
                $ZappliancePassword = Create-OvfProperty ([ref]$propertyKey) -PropertyValue $PersistentSecrets.ZappliancePassword -PropertyId "ZappliancePassword" -PropertyType "password" -Operation "add"
                $propertySpec += ($ZappliancePassword)

                $spec.VAppConfig.Property = $propertySpec

                # Reconfiguring VM with a new properties
                $task = $ZVM.ExtensionData.ReconfigVM_Task($spec)
                $task1 = Get-Task -Id ("Task-$($task.value)")

                #!!! Print of a Wait-Task breaks logs in AVS, so we need to direct it to null
                $task1 | Wait-Task > $null
            }
        }
        catch {
            throw "Failed to add dynamic properties for Zero VM. Exception = $_"
        }
    }
}

function Update_OvfProperty {
    param (
        [Parameter(Mandatory = $true, HelpMessage = "Property name to update")]
        [ValidateNotNullOrEmpty()][string]
        $PropertyName,

        [Parameter(Mandatory = $true, HelpMessage = "Property value")]
        [ValidateNotNullOrEmpty()][string]
        $PropertyValue
    )
    process {
        $ZVM = Get-VM -Name $ZVM_VM_NAME
        if ($null -eq $ZVM) {
            Write-Error "$ZVM_VM_NAME does not exist" -ErrorAction Stop
        }
        else {
            $vappProperties = $ZVM.ExtensionData.Config.VAppConfig.Property
            # Create a new Update spec based on the # of OVF properties to update
            $spec = New-Object VMware.Vim.VirtualMachineConfigSpec
            $spec.vAppConfig = New-Object VMware.Vim.VmConfigSpec

            $propToUpdate = ($vappProperties | Where-Object { $_.Id -eq $PropertyName })[0]

            $VcPasswordProperty = Create-OvfProperty ([ref]$propToUpdate.Key)`
                -PropertyValue "$PropertyValue"`
                -PropertyId $propToUpdate.Id`
                -PropertyType $propToUpdate.Type`
                -Operation "edit"
            $propertySpec = @($VcPasswordProperty)

            $spec.VAppConfig.Property = $propertySpec

            # Reconfiguring VM with a new properties
            $task = $ZVM.ExtensionData.ReconfigVM_Task($spec)
            $task1 = Get-Task -Id ("Task-$($task.value)")

            $task1 | Wait-Task > $null
            Write-Host "OVF property $PropertyName was successfully updated"
        }
    }

}

function Create-OvfProperty {
    param(
        [Parameter(Mandatory = $true, HelpMessage = "Ovf property Key, should be unique")]
        [ref]
        [int]
        $PropertyKey,

        [Parameter(Mandatory = $true, HelpMessage = "Ovf property Value")]
        [string]
        $PropertyValue,

        [Parameter(Mandatory = $true, HelpMessage = "Ovf property Id")]
        [string]
        $PropertyId,

        [Parameter(Mandatory = $true, HelpMessage = "Ovf property Type")]
        [string]
        $PropertyType,

        [Parameter(Mandatory = $true, HelpMessage = "Ovf property operation: edit, add, remove.")]
        [string]
        $Operation
    )

    process {
        Write-Host "Starting $($MyInvocation.MyCommand) $($PropertyId)..."

        $property = New-Object VMware.Vim.VAppPropertySpec
        $property.Operation = $Operation
        $property.Info = New-Object VMware.Vim.VAppPropertyInfo
        $property.Info.Key = $PropertyKey.Value
        $property.Info.value = $PropertyValue
        $property.Info.Id = $PropertyId
        $property.Info.type = $PropertyType
        $PropertyKey.Value++

        return $property
    }
}

function Set-OvfProperties {
    param(
        [Parameter(Mandatory = $true, HelpMessage = "Path for the OVA file")]
        [string]
        $OvaPath,

        [Parameter(Mandatory = $true, HelpMessage = "Zvm IP address")]
        [ValidateNotNullOrEmpty()][string]
        $ZVMLIp,

        [Parameter(Mandatory = $true, HelpMessage = "Network device for ZVML")]
        [ValidateNotNullOrEmpty()][string]
        $NetworkName,

        [Parameter(Mandatory = $true, HelpMessage = "SubnetMask address")]
        [ValidateNotNullOrEmpty()][string]
        $SubnetMask,

        [Parameter(Mandatory = $true, HelpMessage = "Default gateway")]
        [ValidateNotNullOrEmpty()][string]
        $DefaultGateway,

        [Parameter(Mandatory = $true, HelpMessage = "DNS server address")]
        [ValidateNotNullOrEmpty()][string]
        $DNS
    )

    process {
        Write-Host "Starting $($MyInvocation.MyCommand)..."

        try {
            $ovfConfig = Get-OvfConfiguration -Ovf $OvaPath -ErrorAction stop

            Write-Host "The OVF configuration was fetched successfully for $ovaPath"

            $networkOvfPropertyName = ($ovfConfig.NetworkMapping.PSObject.Properties | Select-Object -Index 0).Name
            $ovfConfig.NetworkMapping.$networkOvfPropertyName.Value = $NetworkName

            $ovfConfig.net.ipAddress.Value = $ZVMLIp
            $ovfConfig.net.gateway.Value = $DefaultGateway
            $ovfConfig.net.netmask.Value = $SubnetMask
            $ovfConfig.net.dns.Value = $DNS

            return $ovfConfig
        }

        catch {
            throw "Failed to set OVF properties for $ovfPath, exception = $_"
        }
    }
}