Start-IpsXenExportJob.ps1
|
<# .SYNOPSIS Start an Image Portability Service job to export an image from XenServer. .DESCRIPTION Starts an Image Portability Service job to export an image from XenServer to a virtual disk file on a SMB fileshare. .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 SmbLocation Specifies the SMB URI used to access the SMB server. .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 HashDisk Hash the disk before exporting it and return the hash in the job results. .PARAMETER ResourceLocationId Specifies the UUID of the resource location of the Xen server. .PARAMETER XenCwSecretId Specifies the credential wallet id for the credentials used to access the Xen server. .PARAMETER XenHost Specifies the host name or IP address of the Xen server. .PARAMETER XenPort Specifies the network port number of the Xen server. .PARAMETER XenSslFingerprint Specifies the fingerprint of the Xen SSL certificate. .PARAMETER SourceDiskUuid Specifies the UUID of the image on the Xen server that will be exported. .PARAMETER Network Specifies the name of the network on the Xen server to use for the export. .PARAMETER StorageRepositoryUuid Specifies the UUID of the storage repository on the Xen server to use for the export. .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 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> $ExportParams = @{ CustomerId = 'a7f4wb1example' SecureClientId = '7fed2a1e-1495-46b7-8fd3-5644764af395' SecureSecret = '9T.3Q~MGlnB6NNgpNUUWrcquVzODrdGK~eXampLe' SmbLocation = "smb://example.com/share/folder" SmbDiskName = 'marketing-image' SmbDiskFormat = 'VhdDiskFormat' SmbCwId = 'smbserver-creds' ResourceLocationId = '47251663-6710-4f76-854a-2385e3fe002d' XenCwSecretId = 'xen-creds' XenHost = 'hostname.example.com' XenSslFingerprint = 'db767676e22cefdf4112fc9e6ede9fc879627273' SourceDiskUuid = '123e4567-e89b-12d3-a456-426655440000' Network = 'VM Network' StorageRepositoryUuid = '9496efec-cdf6-4019-a251-4ee57ab5643f' Prefix = 'acme' DryRun = $False Timeout = 7200 LogFileName = '.\XenExport.log' } PS> Start-IpsXenExportJob @ExportParams -Force -OverwriteLog -Verbose | Wait-IpsJob #> Function Start-IpsXenExportJob { [CmdletBinding()] [Alias("Start-IpsXenPublishJob")] 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()] [string]$SmbDiskFormat = "VhdxDiskFormat", [Parameter(Mandatory = $true)] [string]$SmbCwId, [Parameter(Mandatory = $false)] [switch]$HashDisk, [Parameter()] [string]$Deployment, [Parameter(Mandatory = $true)] [string]$ResourceLocationId, [Parameter(Mandatory = $true)] [Alias("CwSecretId")] [string]$XenCwSecretId, [Parameter(Mandatory = $true)] [string]$XenHost, [Parameter()] [int]$XenPort = 443, [Parameter()] [string]$XenSslFingerprint, [Parameter(Mandatory = $true)] [string]$SourceDiskUuid, [Parameter(Mandatory = $true)] [string]$Network, [Parameter(Mandatory = $true)] [string]$StorageRepositoryUuid, [Parameter()] [string]$AssetsId, [Parameter()] [int]$Timeout = 7200, [Parameter()] [string]$Prefix = "ce", [Parameter()] [HashTable]$JobDebug = @{}, [Parameter()] [bool]$DryRun = $false, [Parameter()] [string]$SecureClientId, [Parameter()] [string]$SecureSecret, [Parameter()] [string]$LogFileDir, [Parameter()] [string]$LogFileName = 'ExportXenToSmb.log', [Parameter()] [switch]$OverwriteLog, [Parameter()] [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" } # Export try { LogIt "Starting export workflow" # # Run the export workflow # Write-Host "***** Call Method: ExportImageJob overwrite: $($Force.IsPresent) *****" $platformExportData = @{ platformCredentialId = $XenCwSecretId host = $XenHost port = $XenPort sourceDiskUuid = $SourceDiskUuid network = $Network storageRepositoryUuid = $StorageRepositoryUuid } if ($XenSslFingerprint) { $platformExportData['sslFingerprint'] = $XenSslFingerprint } $exportData = @{ platform = "Xen" prefix = $Prefix ResourceLocationId = $ResourceLocationId timeoutInSeconds = $Timeout outputStorageLocation = @{ Location = $SmbLocation credentialId = $SmbCwId } outputImageFilename = $SmbDiskName outputImageFormat = $SmbDiskFormat hashDisk = $HashDisk.IsPresent provisionType = "Thin" overwriteTargetFile = $Force.IsPresent debug = $JobDebug } if ($AssetsId) { $exportData['assetsId'] = $AssetsId } # Convert the object to JSON to use in the POST body (Note: Default depth is 2 when serializing) $json = ($exportData + $platformExportData) | ConvertTo-Json -Depth 10 LogIt "$($exportData["provisionType"]) Export POST body $json" $Verbose $query = @{ "async" = $true "dryRun" = $DryRun } try { $response = Invoke-CCRestMethod -method 'Post' -deployment $Deployment -serviceRoute "images/`$export" -customerId $CustomerId -secureClientId $SecureClientId -secureSecret $SecureSecret -query $query -json $json $JobId = $response.id LogIt "Image Export started with id $JobId" } catch { $JobId = "Job failed to start" LogFatal "Failed to start export: $_" } } 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 } } } } |