GET ACTIVE SESSION PROPERTIES

USE THIS FUNCTION TO GET ACTIVE PSM SESSION PROPERTIES

Get-VPASActiveSessionProperties -SearchQuery <String> [-token <Hashtable>] [<CommonParameters>]

Get-VPASActiveSessionProperties -ActiveSessionID <String> [-token <Hashtable>] [<CommonParameters>]

Get-VPASActiveSessionProperties -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]

-SearchQuery <String>
Search string to find target resource via username, address, safe, platform, etc.
Comma separated for multiple fields, or to search all pass a blank value like so: " "

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ActiveSessionID <String>
Unique ID that maps to the target ActiveSession
Supply the ActiveSessionID to skip any querying to find the target ActiveSession

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)

$GetActiveSessionPropertiesJSON = Get-VPASActiveSessionProperties -SearchQuery {SEARCHQUERY VALUE}

$GetActiveSessionPropertiesJSON = Get-VPASActiveSessionProperties -ActiveSessionID {ACTIVE SESSION ID VALUE}

$InputParameters = @{
        SearchQuery = "DomainAdmin01"
}
$GetActiveSessionPropertiesJSON = Get-VPASActiveSessionProperties -InputParameters $InputParameters

$InputParameters = @{
        ActiveSessionID = "31_24"
}
$GetActiveSessionPropertiesJSON = Get-VPASActiveSessionProperties -InputParameters $InputParameters

If successful:
{
         "CanTerminate": false,
         "CanMonitor": true,
         "CanSuspend": false,
         "SessionID": "31_24",
         "SessionGuid": "737160df-bba6-494f-875d-8bcf0f5ef9db",
         "SafeName": "PSMRecordings",
         "FolderName": "Root",
         "IsLive": true,
         "FileName": "737160df-bba6-494f-875d-8bcf0f5ef9db.session",
         "Start": 1724215310,
         "End": 0,
         "Duration": 260,
         "User": "administrator",
         "RemoteMachine": "192.168.20.126",
         "ProtectionDate": 0,
         "ProtectedBy": "",
         "ProtectionEnabled": false,
         "AccountUsername": "PSMTestUser",
         "AccountPlatformID": "WinServerLocal",
         "AccountAddress": "192.168.20.126",
         "PIMSuCommand": "",
         "PIMSuCWD": "",
         "ConnectionComponentID": "PSM-RDP",
         "PSMRecordingEntity": "SessionRecording",
         "TicketID": "",
         "FromIP": "192.168.20.1",
         "Protocol": "RDP",
         "Client": "RDP",
         "RiskScore": -1,
         "Severity": "",
         "IncidentDetails": null,
         "RawProperties": {
                 "Address": "192.168.20.126",
                 "ConnectionComponentID": "PSM-RDP",
                 "DeviceType": "Operating System",
                 "EntityVersion": "1.0",
                 "ExpectedRecordingsList": "737160df-bba6-494f-875d-8bcf0f5ef9db.WIN.txt,737160df-bba6-494f-875d-8bcf0f5ef9db.VID.avi",
                 "PSMClientApp": "mstsc.exe",
                 "PSMPasswordID": "5",
                 "PSMProtocol": "RDP",
                 "PSMRecordingEntity": "SessionRecording",
                 "PSMRemoteMachine": "192.168.20.126",
                 "PSMSafeID": "28",
                 "PSMSourceAddress": "192.168.20.1",
                 "PSMStartTime": "1724215310",
                 "PSMStatus": "Placeholder",
                 "PSMVaultUserName": "administrator",
                 "PolicyID": "WinServerLocal",
                 "ProviderID": "PSMApp_COMPONENTS",
                 "UserName": "PSMTestUser",
                 "Safe": "PSMRecordings",
                 "Folder": "Root",
                 "Name": "737160df-bba6-494f-875d-8bcf0f5ef9db.session"
         },
         "RecordingFiles": [
                
         ],
         "RecordedActivities": null,
         "VideoSize": null,
         "TextSize": null,
         "DetailsUrl": null
}

$false if failed