Start FalconScan

Start-FalconScan

SYNOPSIS

Start an on-demand scan

DESCRIPTION

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

PARAMETERS

Name	Type	Min	Max	Allowed	Pipeline	PipelineByName	Description
FilePath	String[]						File path(s) to scan
SensorDetection	String			disabled cautious moderate aggressive extra_aggressive			On-sensor machine-learning detection level
SensorPrevention	String			disabled cautious moderate aggressive extra_aggressive			On-sensor machine-learning prevention level
CloudDetection	String			disabled cautious moderate aggressive extra_aggressive			Cloud-based machine-learning detection level
CloudPrevention	String			disabled cautious moderate aggressive extra_aggressive			Cloud-based machine-learning prevention level
ScanExclusion	String[]						File path(s) to exclude, in glob syntax
Quarantine	Boolean						Quarantine malicious files
MaxFileSize	Int32						Maximum file size, in MB
CpuPriority	String			up_to_1 up_to_25 up_to_50 up_to_75 up_to_100			Maximum CPU utilization
Notification	Boolean
MaxDuration	Int32	0	24				Allowable scan duration, in hours
PauseDuration	Int32	0	24				Allowable pause duration, in hours
Description	String						On-demand scan description
GroupId	String[]						Host Group identifier
Id	String[]				X	X	Host identifier

SYNTAX

Start-FalconScan [-FilePath] <String[]> [-SensorDetection] <String> [-SensorPrevention] <String> [-CloudDetection] <String> [-CloudPrevention] <String> [[-ScanExclusion] <String[]>] [[-Quarantine] <Boolean>] [[-MaxFileSize] <Int32>] [[-CpuPriority] <String>] [[-Notification] <Boolean>] [[-MaxDuration] <Int32>] [[-PauseDuration] <Int32>] [[-Description] <String>] [-GroupId <String[]>] [-Id <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

SDK Reference

falconpy

create_scan

USAGE

2023-01-17: PSFalcon v2.2.4