Start-IpsAhvDiagnosticsJob.ps1
|
<# .SYNOPSIS Start an Image Portability Service job to extract diagnostics from an Ahv image. .DESCRIPTION Start an Image Portability Service job to extract diagnostics from an Ahv image. .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 Ahv. .PARAMETER AhvCwSecretId Specifies the credential wallet id for the credentials used to access the Ahv server. .PARAMETER PrismHost Specifies the host name or IP address of the Prism Element host. .PARAMETER PrismPort Specifies the network port number of the Prism Element host. .PARAMETER PrismSslCaCertificateFilePath Specifies the path to the file containing the Prism SSL certificate. .PARAMETER PrismSslCaCertificate Specifies the Prism host SSL certificate as a single string. .PARAMETER PrismSslFingerprint Specifies the fingerprint of the Prism host SSL certificate. Specified as an alternative to the SSL certificate. .PARAMETER PrismSslNoCheckHostname If specified, do not check the SSL certificate host name (default $false). .PARAMETER SourceImageName Specifies the name of the image on the Prism Element host that diagnostics will be extracted from. If the name is not found or is not unique the job will fail with an error. Exactly one of SourceImageName, SourceImageUuid, or SourceVmUuid must be specified. .PARAMETER SourceImageUuid Specifies the UUID of the image on the Prism Element host that diagnostics will be extracted from. Exactly one of SourceImageName, SourceImageUuid or SourceVmUuid must be specified. .PARAMETER SourceVmUuid Specifies the UUID of the virtual machine on the Prism Element host that diagnostics will be extracted from. Exactly one of SourceImageName, SourceImageUuid or SourceVmUuid must be specified. .PARAMETER ClusterUuid Specifies the UUID of cluster of the Nutanix system where the source image or virtual machine resides. .PARAMETER SubnetUuid Specifies the UUID of subnet of the Nutanix system to use for extracting the diagnostics. .PARAMETER SmbLocation Specifies the SMB URI used to access the SMB server. .PARAMETER SmbCwId Specifies the credential wallet id for the credentials used to access the SMB server. .PARAMETER CeLogs If specified, logs will be collected from the compositing engine. .PARAMETER WindowsEventLogs If specified, Windows event logs will be colected from the image. .PARAMETER IpsData If specified, Image Portability Service specific data will collected from the image. .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 diagnostics operation. .PARAMETER Prefix Specifies an optional prefix which will be prepended to the name of assets created by the diagnostics 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 diagnostics 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> $DiagsParams = @{ CustomerId = 'a7f4wb1example' SecureClientId = '7fed2a1e-1495-46b7-8fd3-5644764af395' SecureSecret = '9T.3Q~MGlnB6NNgpNUUWrcquVzODrdGK~eXampLe' ResourceLocationId = '47251663-6710-4f76-854a-2385e3fe002d' AhvCwSecretId = 'Ahv-creds' PrismHost = 'hostname.example.com' PrismPort = 9440 PrismSslCaCertificate = "-----BEGIN CERTIFICATE-----\nMIIEETCCAvFgAwIBAgIJAPlOYwwTfEIXMA0GCSqGSIb3DQEBCwUAMIGTMQswCQYD\nVQQDDAJDQTEXMBUGCgmSJomT8ixkARkWB3ZzcGhlcmUxFTBTBgoJkiaJk/IsZAEZ\nFgVsb2NhbDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFTATBgNV\nBAoMDGR5LXZjZW50ZXItMTEbMBkGA1UECwwSVk13YXJlIEVuZ2luZWVyaW5nMB4X\nDTIwMDcxNDIyNTUwOVoXDTMwMDcxMjIyNTUwOVowgZMxCzAJBgNVBAMMAkNBMRcw\nFQYKCZImiZPyLGQBGRYHdnNwaGVyZTEVMBMGCgmSJomT8ixkARkWBWxvY2FsMQsw\nCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEVMBMGA1UECgwMZHktdmNl\nbnRlci0xMRswGQYDVQQLDBJWTXdhcmUgRW5naW5lZXJpbmcwggEiMA0GCSqGSIb3\nDQEBAQUAA4IBDwAwggEKAoIBAQCXKo6P9K/ORDHqht10efM9EEAA83dxZzABEbUi\nWFpAacwUwkHoMrnlA2/2hW9k88Dm2SiTYEQ5h39EQARhbPXM54BGjccccamxOyKR\nnhU1JbX11A+/cqnQ54ZrSrXQB7c92Ax56cnVv0thU7ZbEnMmmr/JOBMA+KKjvqS9\nbgH2kNr/zCYjYfFNheIwCXyrPECXEzFtFGMIb2SfCbqAiaKedi3AIU93wyAiRrWL\n9LKIbaAaUTysQnHoIItEWYg/ek67t9Z4g4MhMdVwXBd0sgaLe1FCmKoXaV+OY+uQ\nr4b0TxVZOz6gLMaqtFiP1Prq5WLaSwAvf2NNOqzu2HHUxvZZAgMBAAGjZjBkMB0G\nA1UdDgQWBBQ2XJzbpLLliA7Ph7dymvZoCcd3HzAfBgNVHREEGDAWgQ5lbWFpbEBh\nY21lLmNvbYcEfwAAATAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB\nADANBgkqhkiG9w0BAQsFAAOCAQEAD8VBW5mdqVieJnYSJXWdYaBtehR0WAtBPuth\nmuOhj62t+6zTjHe5OL2OxLHPkDtoLEW9ZIqrrRWSZJ3DPGC0HyXafKTi8r9KVjTL\nuX0AAJ042FotSOB2nYBMSRr69PuXF+fReThutuWZd8Qeo/PHbiLu3V4WCaPKiAnZ\n6+S6n/zNUzfak7e6ZntYqrKeA2U3opSyHwZLQyx49wzmtdYKLUs+gdV2h68nTHV6\nS7iyGr9sPubdzf1P/GN9wyvWA07iFfpx8+ft4PhYExeyMbhv03TUceN7iIzju3CD\n4sdZ66ETY6pBBMP4f7TtQL3wK2DoLkmdqwtzBgPDnqpXsf2bwA==\n-----END CERTIFICATE-----\n" PrismSslNoCheckHostname = $False SourceImageUuid = '123e4567-e89b-12d3-a456-426655440000' ClusterUuid = 'd0659a72-5087-11ed-bdc3-0242ac120002' SubnetUuid = 'd7880448-5087-11ed-bdc3-0242ac120002' SmbLocation = "smb://example.com/share/folder" SmbCwId = "smb-credential-wallet-id" CeLogs = $True WindowsEventLogs = $True IpsData = $True Prefix = 'acme' DryRun = $False Tags = @{ MyTagName = "MyTagValue" } Timeout = 7200 LogFileName = '.\DiagsAhv.log' } PS> Start-IpsAhvDiagnosticsJob @DiagsParams -Force -OverwriteLog -Verbose | Wait-IpsJob .EXAMPLE PS> $DiagsParams = @{ CustomerId = 'a7f4wb1example' SecureClientId = '7fed2a1e-1495-46b7-8fd3-5644764af395' SecureSecret = '9T.3Q~MGlnB6NNgpNUUWrcquVzODrdGK~eXampLe' ResourceLocationId = '47251663-6710-4f76-854a-2385e3fe002d' AhvCwSecretId = 'Ahv-creds' PrismHost = 'hostname.example.com' PrismPort = 9440 PrismSslFingerprint = 'db767676e22cefdf4112fc9e6ede9fc879627273' PrismSslNoCheckHostname = $False SourceVmUuid = '123e4567-e89b-12d3-a456-426655440000' ClusterUuid = 'd0659a72-5087-11ed-bdc3-0242ac120002' SubnetUuid = 'd7880448-5087-11ed-bdc3-0242ac120002' SmbLocation = "smb://example.com/share/folder" SmbCwId = "smb-credential-wallet-id" CeLogs = $False Prefix = 'acme' DryRun = $False Tags = @{ MyTagName = "MyTagValue" } Timeout = 7200 LogFileName = '.\DiagsAhv.log' } PS> Start-IpsAhvDiagnosticsJob @DiagsParams -Force -OverwriteLog -Verbose | Wait-IpsJob #> Function Start-IpsAhvDiagnosticsJob { Param( [Parameter(Mandatory = $true)] [string]$CustomerId, [Parameter(Mandatory = $true)] [string]$AhvCwSecretId, [Parameter(Mandatory = $false)] [string]$Deployment, [Parameter(Mandatory = $true)] [string]$ResourceLocationId, [Parameter(Mandatory = $true)] [string]$PrismHost, [Parameter(Mandatory = $false)] [int]$PrismPort = 9440, [Parameter(Mandatory = $false)] [string]$PrismSslCaCertificateFilePath, [Parameter(Mandatory = $false)] [string]$PrismSslCaCertificate, [Parameter(Mandatory = $false)] [string]$PrismSslFingerprint, [Parameter(Mandatory = $false)] [bool]$PrismSslNoCheckHostname, [Parameter(Mandatory = $false)] [string]$SourceImageName, [Parameter(Mandatory = $false)] [string]$SourceImageUuid, [Parameter(Mandatory = $false)] [string]$SourceVmUuid, [Parameter(Mandatory = $true)] [string]$ClusterUuid, [Parameter(Mandatory = $false)] [string]$SubnetUuid, [Parameter(Mandatory = $true)] [string]$SmbLocation, [Parameter(Mandatory = $true)] [string]$SmbCwId, [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)] [bool]$CeLogs = $true, [Parameter(Mandatory = $false)] [bool]$WindowsEventLogs = $true, [Parameter(Mandatory = $false)] [bool]$IpsData = $true, [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 = 'DiagsAhv.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 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" } try { Write-Host "***** Call Method: ImageDiagnosticsJob *****" $platformDiagsData = @{ host = $PrismHost port = $PrismPort clusterUuid = $ClusterUuid subnetUuid = $SubnetUuid } if ($PrismSslCaCertificateFilePath -And (Test-Path -Path $PrismSslCaCertificateFilePath -PathType "Leaf")) { $platformDiagsData['sslCaCertificate'] = ((Get-Content $PrismSslCaCertificateFilePath) -join "`n") + "`n" } elseif ($prismSslCaCertificate) { # Replace raw string \n -> PowerShell-readable `n $PrismSslCaCertificate = $PrismSslCaCertificate.replace("\n", "`n") $platformDiagsData['sslCaCertificate'] = $PrismSslCaCertificate } elseif ($PrismSslFingerprint) { $platformDiagsData['sslFingerprint'] = $PrismSslFingerprint } if ($PrismSslNoCheckHostname) { $platformDiagsData['sslNoCheckHostname'] = $PrismSslNoCheckHostname } if ($SourceImageName) { $platformDiagsData['sourceImageName'] = $SourceImageName } elseif ($SourceImageUuid) { $platformDiagsData['sourceImageUuid'] = $SourceImageUuid } elseif ($SourceVmUuid) { $platformDiagsData['sourceVmUuid'] = $SourceVmUuid } #Add default tags $Tags['ctx-user'] = ($env:UserName).ToLower() $diagsData = @{ platform = "Ahv" platformCredentialId = $AhvCwSecretId resourceLocationId = $ResourceLocationId outputStorageLocation = @{ credentialId = $SmbCwId Location = $SmbLocation } CeLogs = $CeLogs WindowsEventLogs = $WindowsEventLogs IpsData = $IpsData tags = $Tags timeoutInSeconds = $Timeout prefix = $Prefix overwriteTargetFile = $Force.IsPresent } if ($AssetsId) { $diagsData['assetsId'] = $AssetsId } # Convert the object to JSON to use in the POST body (Note: Default depth is 2 when serializing) $json = ($diagsData + $platformDiagsData) | ConvertTo-Json -Depth 10 LogIt "Ahv Diagnostics POST body $json" $Verbose $query = @{ "async" = $true "dryRun" = $DryRun } # Send the POST try { $response = Invoke-CCRestMethod -method 'Post' -deployment $Deployment -serviceRoute "images/`$diagnostics" -customerId $CustomerId -secureClientId $SecureClientId -secureSecret $SecureSecret -query $query -json $json $JobId = $response.id LogIt "Image diagnostics started with id $JobId" } catch { $JobId = "Job failed to start" throw "Failed to start diagnostics: $_" } } 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 } } } } |