Start-IpsGcpPrepareAndPublishJob.ps1
|
<# .SYNOPSIS Implement an image prepare job followed by an image export job. .DESCRIPTION Implement an image prepare job followed by an image export job. This function supports preparing and publishing an image on GCP platform. .PARAMETER CustomerId Specifies the Citrix customer id to run the command as. .PARAMETER SecureClientId Specifies the id of the access client for the Citrix customer that the export will be performed as. .PARAMETER SecureSecret Specifies the secret for the access client for the Citrix customer that the export will be performed as. .PARAMETER ResourceLocationId Specifies the UUID of the resource location of the Citrix Connector Appliance in GCP. .PARAMETER CloudProvisioningType Specifies the Citrix provisioning type that will be used in the cloud. Possible values are Mcs and Pvs. .PARAMETER CloudCwSecretId Specifies the credential wallet id for the credentials used to access GCP. .PARAMETER XdReconfigure Specifies options to run XenDesktopVdaSetup.exe with during prepare. .PARAMETER CloudDiskName Specifies the name of the image that will be prepared. .PARAMETER GcpZone Specifies the GCP zone name where the prepare appliance will be created. .PARAMETER VpcNetworkName Specifies the name of the VPC that the prepare appliance VM's network interface will be connected to. .PARAMETER VpcNetworkSubnetName Specifies the name of the VPC subnet that the prepare appliance VM's network interface will be connected to. .PARAMETER SmbHost Specifies the host name or IP address of the SMB server to export to. .PARAMETER SmbShare Specifies the share on the SMB server to export to. .PARAMETER SmbPath Specifies the path on the share of the SMB server to export to. .PARAMETER SmbDiskName Specifies the file name of the disk file that will be exported to the SMB server. .PARAMETER SmbDiskFormat Specifies the file format of the disk file that will be exported to the SMB server. Possible values are VhdDiskFormat and VhdxDiskFormat. The default value is VhdxDiskFormat. .PARAMETER SmbCwId Specifies the credential wallet id for the credentials used to access the SMB server. .PARAMETER DomainUnjoin If specified, the image will be unjoined from the domain during prepare. .PARAMETER InstallMisa If specified, and the CloudProvisioningType is Mcs, the version of MCS security agent that matches the VDA installed on the image, will be installed during prepare. .PARAMETER ForceMisa If specified, and the CloudProvisioningType is Mcs, the latest version of MCS security agent will be installed during prepare. .PARAMETER InstallPvs If specified, and the CloudProvisioningType is Pvs, the specified version of the PVS driver will be installed on the image during preapre. The version specified should be the version of the PVS server in AWS. .PARAMETER InstallUpl If specified, the Citrix User Personaliztion Layer will be installed in the image during prepare. .PARAMETER UsePublicIP If specified, the prepare appliance VM will be given a public IP. .PARAMETER Timeout Specifies an optional time limit for the export operation. If the export does not complete in less than this time it will fail with a timeout error. The default value is 7200. .PARAMETER Tags Specifies a hash table of string values to apply as labels to resources created by the prepare operation. .PARAMETER NetworkTags Specifies a hash table of string tag values to apply to prepare appliance VM's network interface. The tags should be existing firewall tags. .PARAMETER Prefix Specifies an optional prefix which will be prepended to the name of assets created by the export operation. The default value is 'ce'. .PARAMETER DryRun If specified, a test run is performed and any problems with the paramters specified are reported. No actual changes are made. .PARAMETER LogFileDir Specifies the path to the file to log to. The local directory is the default. .PARAMETER LogFileName Specifies the name of the file to log to. 'ExportAhvToSmb.log' is the default. .PARAMETER OverwriteLog If specified the log file is overwritten otherwise it is appended to. .PARAMETER Force If specified then any existing export file is overwritten otherwise the operation will fail if the file specified to export to exists. .INPUTS None. .OUTPUTS PSCustomObject. Consumed by the Wait-IpsJob commandlet. .EXAMPLE PS> $PrepareAndPublishParams = @{ CustomerId = 'your Citrix customer ID' SecureClientId = '7fed2a1e-1495-46b7-8fd3-5644764af395' SecureSecret = 'your Citrix secure secret' ResourceLocationId = '47251663-6710-4f76-854a-2385e3fe002d' CloudProvisioningType = 'Mcs' CloudCwSecretId = 'gcp-creds' XdReconfigure = ( @{ ParameterName = "controllers" ParameterValue = "cloudy-cc1.wse2edev.cloudy" }, @{ ParameterName = "portnumber" ParameterValue = "80" } ) CloudDiskName = 'ImageToPrepare' Tags = @{ MyTagName = "MyTagValue" } GcpZone = 'us-east4-a' VpcNetworkName = 'ips-vnet' VpcNetworkSubnetName = 'ips-vnet-subnet' SmbHost = 'smbserver.example.com' SmbShare = 'disks' SmbPath = 'ips' SmbDiskName = 'marketing-image' SmbDiskFormat = 'VhdxDiskFormat' DomainUnjoin = $True InstallMisa = $True InstallUpl = $True Prefix = 'acme' DryRun = $False Timeout = 7200 LogFileName = '.\GcpPrepareAndPublish.log' } PS> Start-IpsGcpPrepareAndPublishJob @PrepareAndPublishParams -Force -OverwriteLog -Verbose | Wait-IpsJob .EXAMPLE PS> $PrepareAndPublishParams = @{ CustomerId = 'your Citrix customer ID' SecureClientId = '7fed2a1e-1495-46b7-8fd3-5644764af395' SecureSecret = 'your Citrix secure secret' ResourceLocationId = '47251663-6710-4f76-854a-2385e3fe002d' CloudProvisioningType = 'Pvs' CloudCwSecretId = 'gcp-creds' XdReconfigure = ( @{ ParameterName = "controllers" ParameterValue = "cloudy-cc1.wse2edev.cloudy" }, @{ ParameterName = "portnumber" ParameterValue = "80" } ) OutputSnapshotName = 'MyPreparedSnapshot Tags = @{ MyTagName = "MyTagValue" } NetworkTags = @{ MyNetTagName = MyNetTagValue } GcpZone = 'us-east4-a' VpcNetworkName = 'ips-vnet' VpcNetworkSubnetName = 'ips-vnet-subnet' SmbHost = 'smbserver.example.com' SmbShare = 'disks' SmbPath = 'ips' SmbDiskName = 'marketing-image' SmbDiskFormat = 'VhdxDiskFormat' InstallPvs = '2209' Prefix = 'acme' DryRun = $False Timeout = 7200 LogFileName = '.\GcpPrepareAndPublish.log' } PS> Start-IpsGcpPrepareAndPublishJob @PrepareAndPublishParams -Force -OverwriteLog -Verbose | Wait-IpsJob #> Function Start-IpsGcpPrepareAndPublishJob { [CmdletBinding(DefaultParameterSetName = 'cmd')] Param( [Parameter(Mandatory = $true, ParameterSetName = 'file')] [Obsolete("Use command-line arguments as input of configuration data.")] [string]$ConfigJsonFile, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$CustomerId, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$CloudProvisioningType = "Pvs", [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$CloudCwSecretId, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$CloudDiskName, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [psobject[]]$XdReconfigure, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$Deployment, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$ResourceLocationId, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$GcpZone = "us-east4-a", [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$VpcNetworkName, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$VpcNetworkSubnetName, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [bool]$UsePublicIP = $false, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string[]]$NetworkTags, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$AssetsId, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [HashTable]$Tags = @{}, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [int]$Timeout = 20000, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$Prefix = "ce", [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$CeVmSku = "n1-standard-1", [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [bool]$JobDebug, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [bool]$DomainUnjoin = $false, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [bool]$InstallMisa = $true, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [bool]$ForceMisa = $false, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$InstallPvs, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$InstallUpl, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$SmbHost, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [Obsolete("Specifying an alternate SMB port is not supported and this parameter will be ignored.")] [string]$SmbPort = $null, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$SmbShare, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$SmbPath, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$SmbDiskName, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$SmbDiskFormat = "VhdxDiskFormat", [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$SmbCwId, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string[]]$Flags, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [bool]$DryRun = $false, [Parameter(Mandatory = $false)] [string]$SecureClientId = '', [Parameter(Mandatory = $false)] [string]$SecureSecret = '', [Parameter(Mandatory = $false)] [string]$LogFileDir = "", [Parameter(Mandatory = $false)] [string]$LogFileName = 'GcpPrepareAndPublish.log', [Parameter(Mandatory = $false)] [switch]$OverwriteLog, [Parameter(Mandatory = $false)] [switch]$Force ) Begin { Add-PSSnapin Citrix.* } Process { # Initialize Logger # Set parameter 'Verbose' by internal parameter 'VerbosePreference', since the option -Verbose is occupied by powershell cmdlet if($VerbosePreference -eq 'Continue') { $Verbose = $True } else { $Verbose = $False } LogInit $LogFileDir $LogFileName $OverwriteLog $Verbose # Initialize config data if ($PSCmdlet.ParameterSetName -eq 'file') { LogIt "Loading config from $ConfigJsonFile" $configData = Get-Content -Raw -Path $ConfigJsonFile | ConvertFrom-Json LogIt "Config: $configData" $False $CustomerId = $configData.CustomerId $CloudProvisioningType = $configData.CloudProvisioningType $CloudCwSecretId = $configData.CloudCwSecretId $CloudDiskName = $configData.CloudDiskName $XdReconfigure = $configData.XdReconfigure $SmbHost = $configData.PublishSmb.Host $SmbShare = $configData.PublishSmb.Share $SmbPath = $configData.PublishSmb.Path $SmbDiskName = $configData.PublishSmb.DiskName $SmbDiskFormat = $configData.PublishSmb.DiskFormat if([String]::IsNullOrWhiteSpace($SmbDiskFormat)) { $SmbDiskFormat = "VhdxDiskFormat" } $SmbCwId = $configData.PublishSmb.CwId $Deployment = $configData.Deployment if($configData.psobject.Properties.name -contains "PrepareResourceLocationId") { $ResourceLocationId = $configData.PrepareResourceLocationId } else { $ResourceLocationId = $configData.ResourceLocationId } if([String]::IsNullOrWhiteSpace($configData.GcpZone)) { $GcpZone = "us-east4-a" } else { $GcpZone = $configData.GcpZone } $VpcNetworkName = $configData.VpcNetworkName $VpcNetworkSubnetName = $configData.VpcNetworkSubnetName $UsePublicIP = $configData.UsePublicIP $NetworkTags = $configData.NetworkTags $AssetsId = $configData.AssetsId if($configData.psobject.Properties.name -contains "Tags") { $Tags = Convert-ObjectToHashtable $$configData.Tags } if([String]::IsNullOrWhiteSpace($configData.Timeout)) { $Timeout = 20000 } else { $Timeout = [int]$configData.Timeout } if([String]::IsNullOrWhiteSpace($configData.Prefix)) { $Prefix = "ce" } else { $Prefix = $configData.Prefix } $JobDebug = $configData.Debug $DomainUnjoin = $configData.DomainUnjoin $InstallMisa = $configData.InstallMisa $ForceMisa = $configData.ForceMisa $InstallPvs = $configData.InstallPvs $InstallUpl = $configData.InstallUpl $Flags = $configData.Flags } try { # Authenticate to Citrix Cloud $parameters = AuthToCitrixCloud $CustomerId $SecureClientId $SecureSecret if ([string]::IsNullOrWhiteSpace($SecureClientId) -Or [string]::IsNullOrWhiteSpace($SecureSecret)) { $SecureClientId = $parameters.ApiKey $SecureSecret = $parameters.SecretKey } } catch { LogFatal "Failed to authenticate to Citrix Cloud" } # Prepare try { LogIt "Starting prepareAndPublish workflow" # # Run the prepare workflow # Write-Host "***** Call Method: prepareAndPublish *****" $platformpreparePublishData = @{ zone = $GcpZone VpcNetworkName = $VpcNetworkName UsePublicIP = $UsePublicIP targetImageName = $CloudDiskName } if ($VpcNetworkSubnetName) { $platformpreparePublishData["VpcNetworkSubnetName"] = $VpcNetworkSubnetName } if ($NetworkTags) { $platformpreparePublishData["NetworkTags"] = $NetworkTags } #Add default tags $Tags['ctx-user'] = ($env:UserName).ToLower() if ($SmbPath) { $smbDiskPath = "$SmbShare\$SmbPath" } else { $smbDiskPath = $SmbShare } $preparePublishData = @{ platform = "Gcp" provisioningType = $CloudProvisioningType platformCredentialId = $CloudCwSecretId resourceLocationId = $ResourceLocationId XdReconfigure = $XdReconfigure tags = $Tags timeoutInSeconds = $Timeout prefix = $Prefix ceVmSku = $CeVmSku outputStorageLocation = @{ type = "SMB" credentialId = $SmbCwId host = $SmbHost sharePath = $smbDiskPath } outputImageFilename = $SmbDiskName outputImageFormat = $SmbDiskFormat provisionType = "Thin" overwriteTargetFile = $Force.IsPresent } if ($AssetsId) { $preparePublishData['assetsId'] = $AssetsId } if ($DomainUnjoin) { $preparePublishData['domainUnjoin'] = $DomainUnjoin } if ($InstallUpl) { $preparePublishData['installUpl'] = $InstallUpl } if ($CloudProvisioningType -eq "Pvs") { if ($InstallPvs) { $preparePublishData['installPvs'] = $InstallPvs } $preparePublishData['installMisa'] = $false $preparePublishData['forceMisa'] = $false } if ($JobDebug) { $preparePublishData['debug'] = $JobDebug } if ($Flags) { $preparePublishData['flags'] = $Flags } # Convert the object to JSON to use in the POST body (Note: Default depth is 2 when serializing) $json = ($preparePublishData + $platformpreparePublishData) | ConvertTo-Json -Depth 10 LogIt "$($preparePublishData["CloudProvisioningType"]) Prepare POST body $json" $False $query = @{ "async" = $true "dryRun" = $DryRun } # Send the POST try { $response = Invoke-CCRestMethod 'Post' $Deployment "images/`$prepareAndPublish" $CustomerId $SecureClientId $SecureSecret $query $json $JobId = $response.id LogIt "Image prepareAndPublish started with id $JobId" } catch { $JobId = "Job failed to start" throw "Failed to start prepareAndPublish: $_" } } catch { LogFatal "Workflow failed: $_" } finally { $output = [PSCustomObject] @{ CustomerId = $CustomerId Deployment = $Deployment JobId = $JobId LogFileDir = $LogFileDir LogFileName = $LogFileName } Write-Output $output # Clear credentials at end of pipeline if ($PSCmdlet.MyInvocation.PipelinePosition -eq $PSCmdlet.MyInvocation.PipelineLength) { Clear-XDCredentials } } } } |