Skip to content

New FalconScheduledScan

bk-cs edited this page Nov 30, 2023 · 3 revisions

New-FalconScheduledScan

SYNOPSIS

Create a scheduled scan targeting host groups

DESCRIPTION

Requires 'On-demand scans (ODS): Write'.

PARAMETERS

Name Type Description Min Max Allowed Pipeline PipelineByName
StartTime String Start time (yyyy-MM-ddThh:mm)
Repeat String Repetition frequency never
daily
weekly
every_other_week
every_4_weeks
monthly
FilePath String[] File path(s) to scan
SensorDetection String On-sensor machine-learning detection level disabled
cautious
moderate
aggressive
extra_aggressive
SensorPrevention String On-sensor machine-learning prevention level disabled
cautious
moderate
aggressive
extra_aggressive
CloudDetection String Cloud-based machine-learning detection level disabled
cautious
moderate
aggressive
extra_aggressive
CloudPrevention String Cloud-based machine-learning prevention level disabled
cautious
moderate
aggressive
extra_aggressive
ScanExclusion String[] File path(s) to exclude, in glob syntax
ScanInclusion String[] File path(s) to include, in glob syntax
Quarantine Boolean Quarantine malicious files
MaxFileSize Int32 Maximum file size, in MB
CpuPriority String Maximum CPU utilization up_to_1
up_to_25
up_to_50
up_to_75
up_to_100
Notification Boolean Show notification to end user
MaxDuration Int32 Allowable scan duration, in hours 0 24
PauseDuration Int32 Allowable pause duration, in hours 0 24
Description String On-demand scan description
Id String[] Host group identifier X X

SYNTAX

New-FalconScheduledScan [-StartTime] <String> [-Repeat] <String> [-FilePath] <String[]> [-SensorDetection] <String> [-SensorPrevention] <String> [-CloudDetection] <String> [-CloudPrevention] <String> [[-ScanExclusion] <String[]>] [[-ScanInclusion] <String[]>] [[-Quarantine] <Boolean>] [[-MaxFileSize] <Int32>] [[-CpuPriority] <String>] [[-Notification] <Boolean>] [[-MaxDuration] <Int32>] [[-PauseDuration] <Int32>] [[-Description] <String>] [-Id] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

REFERENCE

Endpoints

POST /ods/entities/scheduled-scans/v1

falconpy

schedule_scan

USAGE

2023-11-27: PSFalcon v2.2.6

Clone this wiki locally