Skip to content

Update FalconSession

bk-cs edited this page Oct 21, 2022 · 20 revisions

Update-FalconSession

SYNOPSIS

Refresh a single-host or batch Real-time Response session to prevent expiration

DESCRIPTION

Real-time Response sessions expire after 10 minutes by default. Any commands that were issued to a session that take longer than 10 minutes will not return results without refreshing the session to keep it alive until the command process completes.

Requires 'Real Time Response: Read'.

PARAMETERS

Name Type Min Max Allowed Pipeline PipelineByName Description
QueueOffline Boolean Add non-responsive hosts to the offline queue
Timeout Int32 30 600 Length of time to wait for a result, in seconds
HostToRemove String[] Host identifier(s) to remove from a batch Real-time Response session
HostId String X X Host identifier, for a single-host session
BatchId String X Batch session identifier

SYNTAX

Update-FalconSession [[-QueueOffline] <Boolean>] -HostId <String> [-WhatIf] [-Confirm] [<CommonParameters>]
Update-FalconSession [[-QueueOffline] <Boolean>] [[-Timeout] <Int32>] [[-HostToRemove] <String[]>] -BatchId <String> [-WhatIf] [-Confirm] [<CommonParameters>]

SDK Reference

falconpy

RTR-PulseSession
BatchRefreshSessions

USAGE

2022-10-21: PSFalcon v2.2.3

Clone this wiki locally