Functions/Monitoring/Test-PASPSMRecording.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
function Test-PASPSMRecording {
    <#
.SYNOPSIS
Determine if a PSM Session / Recording is valid

.DESCRIPTION
Determines if a provided PSM Session / Recording is valid.
Returns $True if valid.

.PARAMETER SessionID
Unique ID of the recorded PSM session

.EXAMPLE
Test-PASPSMRecording -SessionID 334_3

Tests validity of recorded PSM Session File

.NOTES
Minimum CyberArk Version 11.2

.LINK
https://pspas.pspete.dev/commands/Test-PASPSMRecording
#>

    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$SessionID
    )

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

    PROCESS {

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

        #Create URL for Request
        $URI = "$Script:BaseURI/API/Recordings/$SessionID/valid"

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

    } #process

    END { }#end

}