Start-IpsAzureExportJob.ps1
|
<# .SYNOPSIS Start an Image Portability Service job to export an image from Azure. .DESCRIPTION Starts an Image Portability Service job to export an image from Azure to a virtual disk file on a SMB fileshare. Start-IpsAzurePublishJob is an alias for this cmdlet. .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 Azure. .PARAMETER CloudCwSecretId Specifies the credential wallet id for the credentials used to access Azure. .PARAMETER CloudDiskName Specifies the name of the managed disk that will be exported. .PARAMETER CloudSnapshotName Specifies the name of the snapshot that will be exported. .PARAMETER AzureSubscriptionId Specifies the id of the Azure subscription where the export will take place. .PARAMETER AzureLocation Specifies the Azure location name where the export appliance VM will be created. .PARAMETER AzureVirtualNetworkResourceGroupName Specifies the resource group of the vnet that the export appliance VM's network interface will be connected to. .PARAMETER AzureVirtualNetworkName Specifies the name of the vnet that the export appliance VM's network interface will be connected to. .PARAMETER AzureVirtualNetworkSubnetName Specifies the name of the vnet subnet that the export appliance VM's network interface will be connected to. .PARAMETER AzureVmResourceGroup If specified, the export appliance VM will be created in the supplied resource group. Otherwise a resource group will be created for the export appliance VM and deleted when the prepare operation is complete. .PARAMETER TargetResourceGroup Specifies the Azure resource group name where the disk that will be exported is located. .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 NetworkIsolation If unspecified, the export appliance VM will be network isolated if the Azure user has the permissions required. If specified with value false, the export appliance VM will not be network isolated. If specified with value true, the export appliance VM will be network isolated and the job will fail if the Azure user does not have the permissions required. .PARAMETER UsePublicIP If specified, the export 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 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' ResourceLocationId = '47251663-6710-4f76-854a-2385e3fe002d' CloudCwSecretId = 'azure-creds' CloudDiskName = 'ManagedDiskToExport' Tags = @{ MyTagName = "MyTagValue" } AzureSubscriptionId = 'd7880448-5087-11ed-bdc3-0242ac120002' AzureLocation = 'eastus' AzureVirtualNetworkResourceGroupName = 'ips-vnet-rg' AzureVirtualNetworkName = 'ips-vnet' AzureVirtualNetworkSubnetName = 'ips-vnet-subnet' TargetResourceGroup = 'MyDisksResourceGroup' SmbHost = 'smbserver.example.com' SmbShare = 'disks' SmbPath = 'ips' SmbDiskName = 'marketing-image' SmbDiskFormat = 'VhdxDiskFormat' Prefix = 'acme' Timeout = 7200 } PS> Start-IpsAzureExportJob @ExportParams -Force -OverwriteLog -Verbose | Wait-IpsJob #> Function Start-IpsAzureExportJob { [CmdletBinding(DefaultParameterSetName = 'cmd')] [Alias("Start-IpsAzurePublishJob")] 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 = $true, 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]$Deployment, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$ResourceLocationId, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$AzureSubscriptionId, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$AzureLocation = "eastus", [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$AzureVirtualNetworkResourceGroupName, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$AzureVirtualNetworkName, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$AzureVirtualNetworkSubnetName, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [bool]$NetworkIsolation, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [bool]$UsePublicIP = $false, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$TargetResourceGroup, [Parameter(Mandatory = $false)] [string]$CloudDiskName, [Parameter(Mandatory = $false)] [string]$CloudSnapshotName, [Parameter(Mandatory = $true, ParameterSetName = 'cmd')] [string]$CloudCwSecretId, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$AzureVmResourceGroup, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$AssetsId, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [HashTable]$Tags = @{}, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [int]$Timeout = 7200, [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$Prefix = "ce", [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [string]$CeVmSku = "Standard_D2s_v3", [Parameter(Mandatory = $false, ParameterSetName = 'cmd')] [HashTable]$JobDebug = @{}, [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 = 'ExportAzureToSmb.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 $MyInvocation $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 $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 if([String]::IsNullOrWhiteSpace($CloudDiskName)) { $CloudDiskName = $configData.CloudDiskName } if([String]::IsNullOrWhiteSpace($CloudSnapshotName)) { $CloudSnapshotName = $configData.CloudSnapshotName } $Deployment = $configData.Deployment if($configData.psobject.Properties.name -contains "PublishResourceLocationId") { $ResourceLocationId = $configData.PublishResourceLocationId } else { $ResourceLocationId = $configData.ResourceLocationId } $AzureSubscriptionId = $configData.AzureSubscriptionId if([String]::IsNullOrWhiteSpace($configData.AzureLocation)) { $AzureLocation = 'eastus' } else { $AzureLocation = $configData.AzureLocation } $AzureVirtualNetworkResourceGroupName = $configData.AzureVirtualNetworkResourceGroupName $AzureVirtualNetworkName = $configData.AzureVirtualNetworkName $AzureVirtualNetworkSubnetName = $configData.AzureVirtualNetworkSubnetName $UsePublicIP = $configData.UsePublicIP $TargetResourceGroup = $configData.TargetResourceGroup $CloudCwSecretId = $configData.CloudCwSecretId $AzureVmResourceGroup = $configData.AzureVmResourceGroup $AssetsId = $configData.AssetsId if($configData.psobject.Properties.name -contains "Tags") { $Tags = Convert-ObjectToHashtable $configData.Tags } if([String]::IsNullOrWhiteSpace($configData.Timeout)) { $Timeout = 7200 } else { $Timeout = [int]$configData.Timeout } if([String]::IsNullOrWhiteSpace($configData.Prefix)) { $Prefix = "ce" } else { $Prefix = $configData.Prefix } if(-not([String]::IsNullOrWhiteSpace($configData.Debug))) { $JobDebug = Convert-ObjectToHashtable $configData.Debug } } 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 = $CloudCwSecretId subscriptionId = $AzureSubscriptionId azureRegion = $AzureLocation targetDiskResourceGroupName = $TargetResourceGroup VirtualNetworkResourceGroupName = $AzureVirtualNetworkResourceGroupName VirtualNetworkName = $AzureVirtualNetworkName VirtualNetworkSubnetName = $AzureVirtualNetworkSubnetName UsePublicIP = $UsePublicIP resourceGroup = $AzureVmResourceGroup } if ($CloudDiskName) { $platformExportData['targetDiskName'] = $CloudDiskName } else { $platformExportData['targetSnapshotName'] = $CloudSnapshotName } if ($PSBoundParameters.ContainsKey('NetworkIsolation')) { $platformExportData['networkIsolation'] = $NetworkIsolation } if ($SmbPath) { $smbDiskPath = "$SmbShare\$SmbPath" } else { $smbDiskPath = $SmbShare } #Add default tags $Tags['ctx-user'] = ($env:UserName).ToLower() $exportData = @{ platform = "Azure" prefix = $Prefix CeVmSku = $CeVmSku ResourceLocationId = $ResourceLocationId timeoutInSeconds = $Timeout outputStorageLocation = @{ type = "SMB" credentialId = $SmbCwId host = $SmbHost sharePath = $smbDiskPath } outputImageFilename = $SmbDiskName outputImageFormat = $SmbDiskFormat provisionType = "Thin" overwriteTargetFile = $Force.IsPresent tags = $Tags } if ($AssetsId) { $exportData['assetsId'] = $AssetsId } $exportData['debug'] = $JobDebug # 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" $False $query = @{ "async" = $true "dryRun" = $DryRun } # Send the POST try { $response = Invoke-CCRestMethod 'Post' $Deployment "images/`$export" $CustomerId $SecureClientId $SecureSecret $query $json $JobId = $response.id LogIt "Image Export started with id $JobId" } catch { $JobId = "Job failed to start" throw "Failed to start export: $_" } } catch { LogFatal "Workflow failed: $_" } finally { $output = [PSCustomObject]@{ CustomerId = $CustomerId Deployment = $Deployment JobId = $JobId LogFileDir = $LogFileDir LogFileName = $LogFileName SmbHost = $SmbHost SmbShare = $SmbShare SmbPath = $SmbPath 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 } } } } |