Start-IpsGcpConvertToUefiJob.ps1
|
<# .SYNOPSIS Starts an Image Portability Service job to convert a VHD(X) image from MBR/BIOS to EFI/GPT on Google Cloud. .DESCRIPTION Starts an Image Portability Service job to convert a VHD(X) image on a SMB fileshare from MBR/BIOS to EFI/GPT on Google Cloud. .PARAMETER CustomerId Specifies the customer id of the Citrix customer running this command. .PARAMETER SecureClientId Specifies the client id of the Citrix customer's API client. .PARAMETER SecureSecret Specifies the client secret of the Citrix customer's API client. .PARAMETER ResourceLocationId Specifies the UUID of the resource location of the Citrix Connector Appliance in GCP. .PARAMETER GcpCwSecretId Specifies the credential wallet id for the credentials used to access GCP. .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 SmbLocation Specifies the SMB URI used to access the SMB server. .PARAMETER SmbDiskName Specifies the file name of the disk file on the SMB server that will be converted. .PARAMETER SmbDiskFormat Specifies the file format of the disk file that will be converted. Possible values are VhdDiskFormat and VhdxDiskFormat. The default value is VhdxDiskFormat. .PARAMETER SmbOutputDiskName Specifies the file name of the disk file on the SMB server that will created and receive the output of the conversion. This new disk will be a differential disk parented by the input disk .PARAMETER SmbCwId Specifies the credential wallet id for the credentials used to access the SMB server. .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 export operation. .PARAMETER NetworkTags Specifies a hash table of string tag values to apply to the export 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 parameters specified are reported. No actual changes are made. .PARAMETER Deployment Specifies the service address to send the job request to. It defaults to api.layering.cloud.com. This can be used if necessary to send the request to a geo specific deployment such as api.eu.layering.cloud.com. .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. .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. A job description which can be consumed by the Wait-IpsJob cmdlet. .EXAMPLE PS> $ConvertParams = @{ CustomerId = 'a7f4wb1example' SecureClientId = '7fed2a1e-1495-46b7-8fd3-5644764af395' SecureSecret = '9T.3Q~MGlnB6NNgpNUUWrcquVzODrdGK~eXampLe' ResourceLocationId = '47251663-6710-4f76-854a-2385e3fe002d' GcpCwSecretId = 'gcp-creds' Tags = @{ MyTagName = "MyTagValue" } GcpZone = 'us-east4-a' VpcNetworkName = 'ips-vnet' VpcNetworkSubnetName = 'ips-vnet-subnet' SmbLocation = "smb://example.com/share/folder" SmbDiskName = 'marketing' SmbOutputDiskName = 'marketing-efi' SmbDiskFormat = 'VhdxDiskFormat' Prefix = 'acme' Timeout = 7200 LogFileName = 'ConvertOnGcp.log' } PS> Start-IpsGcpConvertToUefiJob @ConvertParams -Force -OverwriteLog -Verbose | Wait-IpsJob #> Function Start-IpsGcpConvertToUefiJob { [CmdletBinding()] Param( [Parameter(Mandatory = $true)] [string]$CustomerId, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [Obsolete("Replaced by SmbLocation.")] [string]$SmbHost, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [Obsolete("Replaced by SmbLocation.")] [string]$SmbShare, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [Obsolete("Replaced by SmbLocation.")] [uri]$SmbPath, [Parameter(Mandatory = $false)] [string]$SmbLocation, [Parameter(Mandatory = $true)] [string]$SmbDiskName, [Parameter(Mandatory = $true)] [string]$SmbOutputDiskName, [Parameter()] [string]$SmbDiskFormat = "VhdxDiskFormat", [Parameter(Mandatory = $true)] [string]$SmbCwId, [Parameter(Mandatory = $false)] [string]$Deployment, [Parameter(Mandatory = $true)] [string]$ResourceLocationId, [Parameter(Mandatory = $true)] [string]$GcpZone = "us-east4-a", [Parameter(Mandatory = $true)] [string]$VpcNetworkName, [Parameter(Mandatory = $false)] [string]$VpcNetworkSubnetName, [Parameter(Mandatory = $false)] [bool]$UsePublicIP = $false, [Parameter(Mandatory = $true)] [Alias("CloudCwSecretId")] [string]$GcpCwSecretId, [Parameter(Mandatory = $false)] [string[]]$NetworkTags, [Parameter(Mandatory = $false)] [string]$AssetsId, [Parameter(Mandatory = $false)] [HashTable]$Tags = @{}, [Parameter(Mandatory = $false)] [int]$Timeout = 7200, [Parameter(Mandatory = $false)] [string]$Prefix = "ce", [Parameter(Mandatory = $false)] [string]$CeVmSku = "n1-standard-1", [Parameter(Mandatory = $false)] [HashTable]$JobDebug = @{}, [Parameter(Mandatory = $false)] [bool]$DryRun = $false, [Parameter(Mandatory = $false)] [string]$SecureClientId, [Parameter(Mandatory = $false)] [string]$SecureSecret, [Parameter(Mandatory = $false)] [string]$LogFileDir, [Parameter(Mandatory = $false)] [string]$LogFileName = 'ConvertOnGcp.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 $Verbose = $VerbosePreference -eq 'Continue' LogInit $MyInvocation $LogFileDir $LogFileName $OverwriteLog $Verbose VersionCheck $Deployment $CustomerId if ($null -eq $SmbLocation) { if (-not($SmbHost) -or -not($SmbShare)) { LogFatal "Parameter SmbLocation is required" } if ($SmbPath) { $smbDiskPath = "$SmbShare/$SmbPath" } else { $smbDiskPath = $SmbShare } $SmbLocation = [System.UriBuilder]::new('smb', $SmbHost, -1, $smbDiskPath) } 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" } # Convert try { LogIt "Starting convert workflow" # # Run the export workflow # Write-Host "***** Call endpoint: images/`$convertToUefi overwrite: $($Force.IsPresent) *****" $platformConvertData = @{ platformCredentialId = $GcpCwSecretId zone = $GcpZone VpcNetworkName = $VpcNetworkName UsePublicIP = $UsePublicIP } if ($VpcNetworkSubnetName) { $platformConvertData["VpcNetworkSubnetName"] = $VpcNetworkSubnetName } if ($NetworkTags) { $platformConvertData["NetworkTags"] = $NetworkTags } #Add default tags $Tags['ctx-user'] = ($env:UserName).ToLower() $convertData = @{ platform = "Gcp" prefix = $Prefix ceVmSku = $CeVmSku ResourceLocationId = $ResourceLocationId timeoutInSeconds = $Timeout inputStorageLocation = @{ Location = $SmbLocation credentialId = $SmbCwId } inputImageFilename = $SmbDiskName inputImageFormat = $SmbDiskFormat outputImageFilename = $SmbOutputDiskName OverwriteOutput = $Force.IsPresent tags = $Tags debug = $JobDebug } if ($AssetsId) { $convertData['assetsId'] = $AssetsId } # Convert the object to JSON to use in the POST body (Note: Default depth is 2 when serializing) $json = ($convertData + $platformConvertData) | ConvertTo-Json -Depth 10 LogIt "Convert POST body $json" $Verbose $query = @{ "async" = $true "dryRun" = $DryRun } # Send the POST try { $response = Invoke-CCRestMethod 'Post' $Deployment "images/`$convertToUefi" $CustomerId $SecureClientId $SecureSecret $query $json $JobId = $response.id LogIt "Image convert started with id $JobId" } catch { $JobId = "Job failed to start" throw "Failed to start convert: $_" } } catch { LogFatal "Workflow failed: $_" } finally { $output = [PSCustomObject]@{ CustomerId = $CustomerId Deployment = $Deployment JobId = $JobId LogFileDir = $LogFileDir LogFileName = $LogFileName SmbLocation = $SmbLocation SmbDiskName = $SmbDiskName SmbDiskFormat = $SmbDiskFormat SmbCwId = $SmbCwId } Write-Output $output # Clear credentials at end of pipeline if ($PSCmdlet.MyInvocation.PipelinePosition -eq $PSCmdlet.MyInvocation.PipelineLength) { Clear-XDCredentials } } } } |