Functions/Monitoring/Suspend-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
function Suspend-PASPSMSession {
    <#
.SYNOPSIS
Suspends a Live PSM Session.
 
.DESCRIPTION
Suspends a Live PSM session, identified by the unique ID of the PSM Session,
preventing further interaction in the session until it is resumed by Resume-PASPSMSession.
 
.PARAMETER LiveSessionId
The unique ID/SessionGuid of a Live PSM Session.
 
.EXAMPLE
Suspend-PASPSMSession -LiveSessionId $SessionUUID
 
Terminates Live PSM Session identified by the session UUID.
 
.INPUTS
All parameters can be piped by property name
 
.OUTPUTS
None
 
.NOTES
Minimum CyberArk Version 10.2
 
.LINK
https://pspas.pspete.dev/commands/Suspend-PASPSMSession
#>

    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [Alias("SessionGuid")]
        [string]$LiveSessionId
    )

    BEGIN {
        $MinimumVersion = [System.Version]"10.2"
    }#begin

    PROCESS {

        Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $MinimumVersion

        #Create URL for Request
        $URI = "$Script:BaseURI/api/LiveSessions/$($LiveSessionId | Get-EscapedString)/Suspend"

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

            #send request to PAS web service
            Invoke-PASRestMethod -Uri $URI -Method POST -WebSession $Script:WebSession

        }

    } #process

    END { }#end

}