Functions/Connections/New-PASPSMSession.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# .ExternalHelp psPAS-help.xml
function New-PASPSMSession {
    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', 'PSMConnectPrerequisites', Justification = "False Positive")]
    [CmdletBinding(SupportsShouldProcess)]
    [Alias("Get-PASPSMConnectionParameter")]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "PSMConnect"
        )]
        [ValidateNotNullOrEmpty()]
        [string]$AccountID,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [string]$userName,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [securestring]$secret,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [string]$address,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [string]$platformID,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [string]$extraFields,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "PSMConnect"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [string]$reason,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "PSMConnect"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [string]$TicketingSystemName,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "PSMConnect"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [string]$TicketId,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "PSMConnect"
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [string]$ConnectionComponent,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "PSMConnect"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [ValidateSet("Yes", "No")]
        [string]$AllowMappingLocalDrives,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "PSMConnect"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [ValidateSet("Yes", "No")]
        [string]$AllowConnectToConsole,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "PSMConnect"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [ValidateSet("Yes", "No")]
        [string]$RedirectSmartCards,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "PSMConnect"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [string]$PSMRemoteMachine,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "PSMConnect"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [string]$LogonDomain,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "PSMConnect"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [ValidateSet("Yes", "No")]
        [string]$AllowSelectHTML5,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "PSMConnect"
        )]
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "AdHocConnect"
        )]
        [ValidateSet("RDP", "PSMGW")]
        [string]$ConnectionMethod,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateScript( { Test-Path -Path $_ -IsValid })]
        [string]$Path
    )

    BEGIN {

        $AdHocParameters = [Collections.Generic.List[String]]@("ConnectionComponent", "reason", "ticketingSystemName", "ticketId", "ConnectionParams")

    }#begin

    PROCESS {

        #Get all parameters that will be sent in the request
        $boundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove AccountID, ConnectionMethod, Path

        #Nest parameters "AllowMappingLocalDrives", "AllowConnectToConsole","RedirectSmartCards",
        #"PSMRemoteMachine", "LogonDomain" & "AllowSelectHTML5" under ConnectionParams Property
        $boundParameters = $boundParameters | ConvertTo-ConnectionParam

        switch ($PSCmdlet.ParameterSetName) {

            "PSMConnect" {
                Assert-VersionRequirement -RequiredVersion 9.10

                #Create URL for Request
                $URI = "$Script:BaseURI/API/Accounts/$($AccountID)/PSMConnect"

                #Create body of request
                $body = $boundParameters | ConvertTo-Json

                $ShouldProcess = $AccountID

                break

            }

            "AdHocConnect" {
                Assert-VersionRequirement -RequiredVersion 10.5

                #Create URL for Request
                $URI = "$Script:BaseURI/API/Accounts/AdHocConnect"

                #Include decoded password in request
                $boundParameters["secret"] = $(ConvertTo-InsecureString -SecureString $secret)

                #Connection parameters are included under the PSMConnectPrerequisites property of the JSON body, for each one specified
                $boundParameters.keys | Where-Object { $AdHocParameters -contains $PSItem } | ForEach-Object {

                    $PSMConnectPrerequisites = @{ }

                } {

                    #add key=value to hashtable
                    $PSMConnectPrerequisites.Add($PSItem, $boundParameters[$PSItem] )

                } {
                    if ($PSMConnectPrerequisites.keys.count -gt 0) {

                        #If PSMConnectPrerequisites have been specified, add PSMConnectPrerequisites to boundParameters
                        $boundParameters["PSMConnectPrerequisites"] = $PSMConnectPrerequisites

                    }
                }

                #Create body of request
                $body = $boundParameters | Get-PASParameter -ParametersToRemove $AdHocParameters | ConvertTo-Json -Depth 4

                $ShouldProcess = $userName

                break

            }

        }

        $ThisSession = $Script:WebSession

        #if a connection method is specified
        If ($PSBoundParameters.ContainsKey("ConnectionMethod")) {

            #The information needs to passed in the header
            if ($PSBoundParameters["ConnectionMethod"] -eq "RDP") {

                #RDP accept "application/json" response
                $Accept = "application/octet-stream"

            }
            elseif ($PSBoundParameters["ConnectionMethod"] -eq "PSMGW") {

                Assert-VersionRequirement -RequiredVersion 10.2

                #PSMGW accept * / * response
                $Accept = "* / *"

            }

            #add detail to header
            $ThisSession.Headers["Accept"] = $Accept

        }

        if ($PSCmdlet.ShouldProcess($ShouldProcess, "New PSM Session")) {

            #send request to PAS web service
            $result = Invoke-PASRestMethod -Uri $URI -Method POST -Body $body -WebSession $ThisSession

        }

        If ($null -ne $result) {

            If (($result | Get-Member -MemberType NoteProperty | Select-Object -ExpandProperty Name) -contains "PSMGWRequest") {

                #Return PSM GW URL Details
                $result

            }
            Else {

                #Save the RDP file to disk
                Out-PASFile -InputObject $result -Path $Path

            }

        }

    } #process

    END { }#end

}