Skip to content

Get FalconScheduledReport

bk-cs edited this page Sep 22, 2022 · 24 revisions

Get-FalconScheduledReport

SYNOPSIS

Search for scheduled report or searches and their execution information

DESCRIPTION

Requires 'Scheduled Reports: Read'.

PARAMETERS

Name Type Min Max Allowed Pipeline PipelineByName Description
Id String[] X X Scheduled report or scheduled search identifier
Filter String Falcon Query Language expression to limit results
Query String Perform a generic substring search across available fields
Sort String created_on.asc
created_on.desc
last_updated_on.asc
last_updated_on.desc
last_execution_on.asc
last_execution_on.desc
next_execution_on.asc
next_execution_on.desc
Property and direction to sort results
Limit Int32 1 5000 Maximum number of results per request
Offset Int32 Position to begin retrieving results
Execution Switch Retrieve information about scheduled report execution
Detailed Switch Retrieve detailed information
All Switch Repeat requests until all available results are retrieved
Total Switch Display total result count instead of results

SYNTAX

Get-FalconScheduledReport [[-Filter] <String>] [[-Query] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [-Offset <Int32>] [-Detailed] [-All] -Total] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-FalconScheduledReport -Id <String[]> -Execution [-WhatIf] [-Confirm] [<CommonParameters>]
Get-FalconScheduledReport -Id <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
Get-FalconScheduledReport [[-Filter] <String>] [[-Query] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [-Offset <Int32>] -Execution [-Detailed] -All] [-Total] [-WhatIf] [-Confirm] [<CommonParameters>]

Generated 20220922 using PSFalcon v2.2.3

Clone this wiki locally