LodPx

1.0.8.10

public/Start-LodPxLabSession.ps1

                                <#############################################################################

TBD

Copyright 2015-2017 Kirk Munro

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

#############################################################################>

function Start-LodPxLabSession {

    [CmdletBinding()]

    [OutputType('LabOnDemand.Session')]

    param(

        [Parameter(Position=0, Mandatory=$true)]

        [ValidateNotNullOrEmpty()]

        [System.String]

        $FirstName,

        [Parameter(Position=1, Mandatory=$true)]

        [ValidateNotNullOrEmpty()]

        [System.String]

        $LastName,

        [Parameter(Position=2, Mandatory=$true)]

        [ValidateNotNullOrEmpty()]

        [System.String]

        $Email,

        [Parameter()]

        [ValidateNotNullOrEmpty()]

        [System.String]

        $UserId,

        [Parameter()]

        [ValidateNotNullOrEmpty()]

        [System.String]

        $Tag,

        [Parameter()]

        [ValidateNotNull()]

        [System.Collections.Hashtable]

        $AdditionalParameters = @{},

        [Parameter(Mandatory=$true)]

        [ValidateRange(1,[System.UInt64]::MaxValue)]

        [System.UInt64]

        $LabId,

        [Parameter(Mandatory=$true)]

        [ValidateScript({

            if ($_ -eq [System.Guid]::Empty) {

                throw 'An empty guid is not a valid API key.'

            }

            $true

        })]

        [System.Guid]

        $ApiKey,

        [Parameter()]

        [ValidateNotNullOrEmpty()]

        [System.String]

        $ServerAddress

    )

    try {

        #region Identify any pass-through parameters that will be used for splatting.

        $passThruParameters = @{}

        foreach ($passThruParameterName in 'ApiKey','ServerAddress') {

            if ($PSCmdlet.MyInvocation.BoundParameters.ContainsKey($passThruParameterName)) {

                $passThruParameters[$passThruParameterName] = $PSCmdlet.MyInvocation.BoundParameters[$passThruParameterName]

            }

        }

        #endregion

        #region If the caller didn't provide a UserId, use the email address as the UserId.

        if (-not $PSCmdlet.MyInvocation.BoundParameters.ContainsKey('UserId')) {

            $PSCmdlet.MyInvocation.BoundParameters['UserId'] = $UserId = $Email

        }

        #endregion

        #region Build a collection of query parameters.

        $parameters = [ordered]@{

                          labId = $LabId

            canBeMarkedComplete = 2 # false

        }

        foreach ($parameterName in 'userId','firstName','lastName','email','tag') {

            if ($PSCmdlet.MyInvocation.BoundParameters.ContainsKey($parameterName)) {

                $parameters[$parameterName] = $PSCmdlet.MyInvocation.BoundParameters[$parameterName]

            }

        }

        foreach ($key in $AdditionalParameters.Keys) {

            $parameters[$key] = $AdditionalParameters[$key]

        }

        #endregion

        #region Request a new lab session.

        $results = Invoke-LodPxWebMethod -Name launch -Parameters $parameters @passThruParameters

        #endregion

        #region Check the results for error.

        $errorCodes = @{

             0 = 'Error'

             2 = 'User has too many active labs'

             3 = 'Insufficient host resources'

             5 = 'API integration has too many active labs'

             6 = 'User has a saved instance of this lab'

             7 = 'API integration doesn''t have enough available RAM'

            10 = 'User doesn''t have enough available RAM'

            20 = 'User''s organization has too many active labs'

            30 = 'User''s organization doesn''t have enough available RAM'

            40 = 'Lab profile has too many active instances'

            50 = 'Lab organization doesn''t have enough available RAM.'

            60 = 'Lab organization has too many active instances'

            70 = 'Lab series has too many active instances'

            80 = 'Lab series doesn''t have enough available RAM'

        }

        if ([int]$results.Status -ne 1) {

            if ($errorCodes.Keys -contains [int]$results.Status) {

                throw "$($errorCodes[[int]$results.Status]). Error message: $($results.Error)."

            } else {

                throw "The server returned an undocumented error code. Error code: $($results.Status). Error message: $($results.Error)."

            }

        }

        #endregion

        #region Return the lab session details to the caller.

        [pscustomobject]@{

               PSTypeName = 'LabOnDemand.Session'

                      Url = $results.Url

            LabInstanceId = $results.LabInstanceId

                  Expires = ConvertFrom-UnixEpochTime -Value $results.Expires

        }

        #endregion

    } catch {

        $PSCmdlet.ThrowTerminatingError($_)

    }

}

Export-ModuleMember -Function Start-LodPxLabSession

New-Alias -Name New-LodPxLabSession -Value Start-LodPxLabSession -ErrorAction Ignore

if ($?) {

    Export-ModuleMember -Alias New-LodPxLabSession

}

# SIG # Begin signature block

# MIIX0AYJKoZIhvcNAQcCoIIXwTCCF70CAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB

# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR

# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUuvrnJHxCYGD13TUuAhlyo36a

# WJygghMDMIID7jCCA1egAwIBAgIQfpPr+3zGTlnqS5p31Ab8OzANBgkqhkiG9w0B

# AQUFADCBizELMAkGA1UEBhMCWkExFTATBgNVBAgTDFdlc3Rlcm4gQ2FwZTEUMBIG

# A1UEBxMLRHVyYmFudmlsbGUxDzANBgNVBAoTBlRoYXd0ZTEdMBsGA1UECxMUVGhh

# d3RlIENlcnRpZmljYXRpb24xHzAdBgNVBAMTFlRoYXd0ZSBUaW1lc3RhbXBpbmcg

# Q0EwHhcNMTIxMjIxMDAwMDAwWhcNMjAxMjMwMjM1OTU5WjBeMQswCQYDVQQGEwJV

# UzEdMBsGA1UEChMUU3ltYW50ZWMgQ29ycG9yYXRpb24xMDAuBgNVBAMTJ1N5bWFu

# dGVjIFRpbWUgU3RhbXBpbmcgU2VydmljZXMgQ0EgLSBHMjCCASIwDQYJKoZIhvcN

# AQEBBQADggEPADCCAQoCggEBALGss0lUS5ccEgrYJXmRIlcqb9y4JsRDc2vCvy5Q

# WvsUwnaOQwElQ7Sh4kX06Ld7w3TMIte0lAAC903tv7S3RCRrzV9FO9FEzkMScxeC

# i2m0K8uZHqxyGyZNcR+xMd37UWECU6aq9UksBXhFpS+JzueZ5/6M4lc/PcaS3Er4

# ezPkeQr78HWIQZz/xQNRmarXbJ+TaYdlKYOFwmAUxMjJOxTawIHwHw103pIiq8r3

# +3R8J+b3Sht/p8OeLa6K6qbmqicWfWH3mHERvOJQoUvlXfrlDqcsn6plINPYlujI

# fKVOSET/GeJEB5IL12iEgF1qeGRFzWBGflTBE3zFefHJwXECAwEAAaOB+jCB9zAd

# BgNVHQ4EFgQUX5r1blzMzHSa1N197z/b7EyALt0wMgYIKwYBBQUHAQEEJjAkMCIG

# CCsGAQUFBzABhhZodHRwOi8vb2NzcC50aGF3dGUuY29tMBIGA1UdEwEB/wQIMAYB

# Af8CAQAwPwYDVR0fBDgwNjA0oDKgMIYuaHR0cDovL2NybC50aGF3dGUuY29tL1Ro

# YXd0ZVRpbWVzdGFtcGluZ0NBLmNybDATBgNVHSUEDDAKBggrBgEFBQcDCDAOBgNV

# HQ8BAf8EBAMCAQYwKAYDVR0RBCEwH6QdMBsxGTAXBgNVBAMTEFRpbWVTdGFtcC0y

# MDQ4LTEwDQYJKoZIhvcNAQEFBQADgYEAAwmbj3nvf1kwqu9otfrjCR27T4IGXTdf

# plKfFo3qHJIJRG71betYfDDo+WmNI3MLEm9Hqa45EfgqsZuwGsOO61mWAK3ODE2y

# 0DGmCFwqevzieh1XTKhlGOl5QGIllm7HxzdqgyEIjkHq3dlXPx13SYcqFgZepjhq

# IhKjURmDfrYwggSjMIIDi6ADAgECAhAOz/Q4yP6/NW4E2GqYGxpQMA0GCSqGSIb3

# DQEBBQUAMF4xCzAJBgNVBAYTAlVTMR0wGwYDVQQKExRTeW1hbnRlYyBDb3Jwb3Jh

# dGlvbjEwMC4GA1UEAxMnU3ltYW50ZWMgVGltZSBTdGFtcGluZyBTZXJ2aWNlcyBD

# QSAtIEcyMB4XDTEyMTAxODAwMDAwMFoXDTIwMTIyOTIzNTk1OVowYjELMAkGA1UE

# BhMCVVMxHTAbBgNVBAoTFFN5bWFudGVjIENvcnBvcmF0aW9uMTQwMgYDVQQDEytT

# eW1hbnRlYyBUaW1lIFN0YW1waW5nIFNlcnZpY2VzIFNpZ25lciAtIEc0MIIBIjAN

# BgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAomMLOUS4uyOnREm7Dv+h8GEKU5Ow

# mNutLA9KxW7/hjxTVQ8VzgQ/K/2plpbZvmF5C1vJTIZ25eBDSyKV7sIrQ8Gf2Gi0

# jkBP7oU4uRHFI/JkWPAVMm9OV6GuiKQC1yoezUvh3WPVF4kyW7BemVqonShQDhfu

# ltthO0VRHc8SVguSR/yrrvZmPUescHLnkudfzRC5xINklBm9JYDh6NIipdC6Anqh

# d5NbZcPuF3S8QYYq3AhMjJKMkS2ed0QfaNaodHfbDlsyi1aLM73ZY8hJnTrFxeoz

# C9Lxoxv0i77Zs1eLO94Ep3oisiSuLsdwxb5OgyYI+wu9qU+ZCOEQKHKqzQIDAQAB

# o4IBVzCCAVMwDAYDVR0TAQH/BAIwADAWBgNVHSUBAf8EDDAKBggrBgEFBQcDCDAO

# BgNVHQ8BAf8EBAMCB4AwcwYIKwYBBQUHAQEEZzBlMCoGCCsGAQUFBzABhh5odHRw

# Oi8vdHMtb2NzcC53cy5zeW1hbnRlYy5jb20wNwYIKwYBBQUHMAKGK2h0dHA6Ly90

# cy1haWEud3Muc3ltYW50ZWMuY29tL3Rzcy1jYS1nMi5jZXIwPAYDVR0fBDUwMzAx

# oC+gLYYraHR0cDovL3RzLWNybC53cy5zeW1hbnRlYy5jb20vdHNzLWNhLWcyLmNy

# bDAoBgNVHREEITAfpB0wGzEZMBcGA1UEAxMQVGltZVN0YW1wLTIwNDgtMjAdBgNV

# HQ4EFgQURsZpow5KFB7VTNpSYxc/Xja8DeYwHwYDVR0jBBgwFoAUX5r1blzMzHSa

# 1N197z/b7EyALt0wDQYJKoZIhvcNAQEFBQADggEBAHg7tJEqAEzwj2IwN3ijhCcH

# bxiy3iXcoNSUA6qGTiWfmkADHN3O43nLIWgG2rYytG2/9CwmYzPkSWRtDebDZw73

# BaQ1bHyJFsbpst+y6d0gxnEPzZV03LZc3r03H0N45ni1zSgEIKOq8UvEiCmRDoDR

# EfzdXHZuT14ORUZBbg2w6jiasTraCXEQ/Bx5tIB7rGn0/Zy2DBYr8X9bCT2bW+IW

# yhOBbQAuOA2oKY8s4bL0WqkBrxWcLC9JG9siu8P+eJRRw4axgohd8D20UaF5Mysu

# e7ncIAkTcetqGVvP6KUwVyyJST+5z3/Jvz4iaGNTmr1pdKzFHTx/kuDDvBzYBHUw

# ggUwMIIEGKADAgECAhAECRgbX9W7ZnVTQ7VvlVAIMA0GCSqGSIb3DQEBCwUAMGUx

# CzAJBgNVBAYTAlVTMRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3

# dy5kaWdpY2VydC5jb20xJDAiBgNVBAMTG0RpZ2lDZXJ0IEFzc3VyZWQgSUQgUm9v

# dCBDQTAeFw0xMzEwMjIxMjAwMDBaFw0yODEwMjIxMjAwMDBaMHIxCzAJBgNVBAYT

# AlVTMRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2Vy

# dC5jb20xMTAvBgNVBAMTKERpZ2lDZXJ0IFNIQTIgQXNzdXJlZCBJRCBDb2RlIFNp

# Z25pbmcgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQD407Mcfw4R

# r2d3B9MLMUkZz9D7RZmxOttE9X/lqJ3bMtdx6nadBS63j/qSQ8Cl+YnUNxnXtqrw

# nIal2CWsDnkoOn7p0WfTxvspJ8fTeyOU5JEjlpB3gvmhhCNmElQzUHSxKCa7JGnC

# wlLyFGeKiUXULaGj6YgsIJWuHEqHCN8M9eJNYBi+qsSyrnAxZjNxPqxwoqvOf+l8

# y5Kh5TsxHM/q8grkV7tKtel05iv+bMt+dDk2DZDv5LVOpKnqagqrhPOsZ061xPeM

# 0SAlI+sIZD5SlsHyDxL0xY4PwaLoLFH3c7y9hbFig3NBggfkOItqcyDQD2RzPJ6f

# pjOp/RnfJZPRAgMBAAGjggHNMIIByTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1Ud

# DwEB/wQEAwIBhjATBgNVHSUEDDAKBggrBgEFBQcDAzB5BggrBgEFBQcBAQRtMGsw

# JAYIKwYBBQUHMAGGGGh0dHA6Ly9vY3NwLmRpZ2ljZXJ0LmNvbTBDBggrBgEFBQcw

# AoY3aHR0cDovL2NhY2VydHMuZGlnaWNlcnQuY29tL0RpZ2lDZXJ0QXNzdXJlZElE

# Um9vdENBLmNydDCBgQYDVR0fBHoweDA6oDigNoY0aHR0cDovL2NybDQuZGlnaWNl

# cnQuY29tL0RpZ2lDZXJ0QXNzdXJlZElEUm9vdENBLmNybDA6oDigNoY0aHR0cDov

# L2NybDMuZGlnaWNlcnQuY29tL0RpZ2lDZXJ0QXNzdXJlZElEUm9vdENBLmNybDBP

# BgNVHSAESDBGMDgGCmCGSAGG/WwAAgQwKjAoBggrBgEFBQcCARYcaHR0cHM6Ly93

# d3cuZGlnaWNlcnQuY29tL0NQUzAKBghghkgBhv1sAzAdBgNVHQ4EFgQUWsS5eyoK

# o6XqcQPAYPkt9mV1DlgwHwYDVR0jBBgwFoAUReuir/SSy4IxLVGLp6chnfNtyA8w

# DQYJKoZIhvcNAQELBQADggEBAD7sDVoks/Mi0RXILHwlKXaoHV0cLToaxO8wYdd+

# C2D9wz0PxK+L/e8q3yBVN7Dh9tGSdQ9RtG6ljlriXiSBThCk7j9xjmMOE0ut119E

# efM2FAaK95xGTlz/kLEbBw6RFfu6r7VRwo0kriTGxycqoSkoGjpxKAI8LpGjwCUR

# 4pwUR6F6aGivm6dcIFzZcbEMj7uo+MUSaJ/PQMtARKUT8OZkDCUIQjKyNookAv4v

# cn4c10lFluhZHen6dGRrsutmQ9qzsIzV6Q3d9gEgzpkxYz0IGhizgZtPxpMQBvwH

# gfqL2vmCSfdibqFT+hKUGIUukpHqaGxEMrJmoecYpJpkUe8wggUyMIIEGqADAgEC

# AhABcG33bGmgMXqaPDxFxG7xMA0GCSqGSIb3DQEBCwUAMHIxCzAJBgNVBAYTAlVT

# MRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j

# b20xMTAvBgNVBAMTKERpZ2lDZXJ0IFNIQTIgQXNzdXJlZCBJRCBDb2RlIFNpZ25p

# bmcgQ0EwHhcNMTYxMTAzMDAwMDAwWhcNMTcxMTIyMTIwMDAwWjBvMQswCQYDVQQG

# EwJDQTEWMBQGA1UECBMNTmV3IEJydW5zd2ljazEQMA4GA1UEBxMHU2hlZGlhYzEa

# MBgGA1UEChMRS2lyayBBbmRyZXcgTXVucm8xGjAYBgNVBAMTEUtpcmsgQW5kcmV3

# IE11bnJvMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3v9YwSFN4+E6

# izQlYrpVQXBSIKWt8L0QhxmkWwrSqQWe0mX8UsTKwVK5db+q2e0KtossjPG3T5go

# rn1C9DUXp1SeIEfP6N6n+6ZMJd4m3v2I9gVXVQ5PwBgo8np92O4fduz8SV3T8vnl

# VJL1CnTkQO4IW4CICUf7N6tSSYAZI7dzdPQ+GM1L22DS41ZWkaOnpQGu1oXf2Vw3

# DwJgCkT5WPho/7cVSrqc7Xg7scn7XUxXHD/Zu2lNKhjpGYTc9nYU//vXUHuAm06A

# rTMxcImGpNGfgtK+T3r/7DMZGCEfmmdb2khRNuqBPJCi++JovAfpP7/Vtd5IHe1r

# 5HvEfmSrtQIDAQABo4IBxTCCAcEwHwYDVR0jBBgwFoAUWsS5eyoKo6XqcQPAYPkt

# 9mV1DlgwHQYDVR0OBBYEFE17ULqi4+fU2lXCUQc55Iu7bHw7MA4GA1UdDwEB/wQE

# AwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzB3BgNVHR8EcDBuMDWgM6Axhi9odHRw

# Oi8vY3JsMy5kaWdpY2VydC5jb20vc2hhMi1hc3N1cmVkLWNzLWcxLmNybDA1oDOg

# MYYvaHR0cDovL2NybDQuZGlnaWNlcnQuY29tL3NoYTItYXNzdXJlZC1jcy1nMS5j

# cmwwTAYDVR0gBEUwQzA3BglghkgBhv1sAwEwKjAoBggrBgEFBQcCARYcaHR0cHM6

# Ly93d3cuZGlnaWNlcnQuY29tL0NQUzAIBgZngQwBBAEwgYQGCCsGAQUFBwEBBHgw

# djAkBggrBgEFBQcwAYYYaHR0cDovL29jc3AuZGlnaWNlcnQuY29tME4GCCsGAQUF

# BzAChkJodHRwOi8vY2FjZXJ0cy5kaWdpY2VydC5jb20vRGlnaUNlcnRTSEEyQXNz

# dXJlZElEQ29kZVNpZ25pbmdDQS5jcnQwDAYDVR0TAQH/BAIwADANBgkqhkiG9w0B

# AQsFAAOCAQEAsjePAnvbVwZQ3W1h2rm/0nheYHeOz6Uz2lOLAsSlCnL2Dhcl4jJR

# Tn+VR4hdAVFYa0Lo87UAG9Cy4GjSNnWqj9AHs9rO0dIlEgks3Ov40XC8zbM5td9j

# /2fwXMccLagqkNHjvng3f5ap2kfy7KgwgSA+uL5pXXhnRYvKtmenIU5GvivxLx3n

# DffGTlI9Ny51yXpOrTL1+cs4tC6dzJfo3c2CD0M8mrHlJqUHC+6Hg3SPRWdRJZGo

# 8+h2nH7F2/Al4JxgkoHuqznwF1W4AfRqF/lkjyDXHMwm5NPnCw4YCUv2s6PvUS08

# SWLSWo/5nh2DXynXQPY0RsH79Sx+/FrVJTGCBDcwggQzAgEBMIGGMHIxCzAJBgNV

# BAYTAlVTMRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdp

# Y2VydC5jb20xMTAvBgNVBAMTKERpZ2lDZXJ0IFNIQTIgQXNzdXJlZCBJRCBDb2Rl

# IFNpZ25pbmcgQ0ECEAFwbfdsaaAxepo8PEXEbvEwCQYFKw4DAhoFAKB4MBgGCisG

# AQQBgjcCAQwxCjAIoAKAAKECgAAwGQYJKoZIhvcNAQkDMQwGCisGAQQBgjcCAQQw

# HAYKKwYBBAGCNwIBCzEOMAwGCisGAQQBgjcCARUwIwYJKoZIhvcNAQkEMRYEFLSl

# aMDaqDiPXn6DFeVl7vvnlHVbMA0GCSqGSIb3DQEBAQUABIIBAN38RpXC/C3erBFK

# LfPGg/8/TyB2YyS+f3albPJ78vbcz/0p7hPuTSQQAb2mte55B0j6nfbXjIJNAbGt

# PDCzhPQ+8D9Z60eX5mmq/j5WhGfGCK9YBnIvp9a5OO6GQ0W6qju823ONgT5mftIg

# SUuhT5bTBqtGL6QdjwPbR11RPb4EVePyluvR3zyOv8wZVKWhHnkldFnjD3hkj3o0

# P9iV84f5lZmwd+SbXcW/Ou2uDSG0aRzEVL8d45y9zE9/iUoyUz5msALHGUshX/n5

# aaNzCvfii3chr0pdI8bZWz3z9FXQybNVBXRH1WppehIqccbDv33B53Emcv7Jo0xF

# PHkEoVGhggILMIICBwYJKoZIhvcNAQkGMYIB+DCCAfQCAQEwcjBeMQswCQYDVQQG

# EwJVUzEdMBsGA1UEChMUU3ltYW50ZWMgQ29ycG9yYXRpb24xMDAuBgNVBAMTJ1N5

# bWFudGVjIFRpbWUgU3RhbXBpbmcgU2VydmljZXMgQ0EgLSBHMgIQDs/0OMj+vzVu

# BNhqmBsaUDAJBgUrDgMCGgUAoF0wGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAc

# BgkqhkiG9w0BCQUxDxcNMTcwNjE5MTY0MDA3WjAjBgkqhkiG9w0BCQQxFgQUYstk

# PNZyztbU48JVAXxgXt5se+swDQYJKoZIhvcNAQEBBQAEggEAPnL0fSzMCJaBphKs

# x/1+aM5bOT2Fe0IY+ANqkUpCRe1ZRe1ehWegyCT0y9IXGtGeQ3RV5QW+UWnjVBlE

# u16vD3GhFxtVS93XjymDEg5hffZXMHdlpYXlYXSPr33LBcDiCuUnYr8OD95H6NqA

# nzUdMK5vZorAn0/jde2y8IQrM7FbScC5IovKLgznUVVGxBNHsiiXAfjgGYqsoeqx

# bUI5b4KEQICJpM93XlNmfbDTEVdnTZcaKx3u8PYRkW3InqGYjDs9l/1px4Tx/3yS

# gcJRLdbJFLaicGxRm0V2DG1hAX68Rug09NFrl8SiEjAUV/N4HBhPvgt7uodtdvVI

# pXFJcA==

# SIG # End signature block