Functions/Monitoring/Get-PASPSMSessionActivity.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
function Get-PASPSMSessionActivity {
    <#
.SYNOPSIS
Get activity details of Live PSM Sessions
 
.DESCRIPTION
Returns activity details of active PSM sessions.
 
.PARAMETER liveSessionId
The ID of an active session to get activities from.
 
.EXAMPLE
Get-PASPSMSessionActivity -liveSessionId 123_45
 
Returns details of activities in active PSM Session with Id 123_45
 
.INPUTS
All parameters can be piped by property name
 
.OUTPUTS
Output format is defined via psPAS.Format.ps1xml.
To force all output to be shown, pipe to Select-Object *
 
.NOTES
Minimum CyberArk Version 10.6
 
.LINK
https://pspas.pspete.dev/commands/Get-PASPSMSessionActivity
#>

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

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

    PROCESS {

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

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

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

        If ($result) {

            #Return Results
            $result.Activities |

            Add-ObjectDetail -typename psPAS.CyberArk.Vault.PSM.Session.Activity

        } #process

    }

    END { }#end

}