New FalconItScheduledTask - CrowdStrike/psfalcon GitHub Wiki
Schedule a Falcon for IT task
Requires 'IT Automation - Task Executions: Write'.
Name | Type | Description | Min | Max | Allowed | Pipeline | PipelineByName |
---|---|---|---|---|---|---|---|
TaskId | String | Task identifier | X | ||||
Target | String | Falcon Query Language expression to define target hosts | X | ||||
Schedule | Object | Key/value pairs to define task scheduling | X | ||||
Enabled | Boolean | Scheduled task enablement status | X | ||||
Trigger | Object[] | Trigger condition | X | ||||
ExecutionArg | Object | Key/value pairs to define arguments during execution of an existing task | X | ||||
DiscoverOffline | Boolean | Discover offline hosts | X | ||||
DiscoverNew | Boolean | Discover new hosts | X | ||||
Guardrail | Object | Execution guardrails and limits | X | ||||
Distribute | Boolean | Distribute task | X | ||||
ExpirationInterval | String | Interval before task expires. Once expired, new and offline hosts won't be targeted | X |
New-FalconItScheduledTask [-TaskId] <String> [-Target] <String> [-Schedule] <Object> [-Enabled] <Boolean> [[-Trigger] <Object[]>] [[-ExecutionArg] <Object>] [[-DiscoverOffline] <Boolean>] [[-DiscoverNew] <Boolean>] [[-Guardrail] <Object>] [[-Distribute] <Boolean>] [[-ExpirationInterval] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
POST /it-automation/entities/scheduled-tasks/v1
New-FalconItScheduledTask -TaskId <id> -Target "platform_name:'Windows'" -Schedule @{ timezone = '-0500'; start_time = '2025-05-14T21:57:00.000Z'; frequency = 'One-Time' } -Guardrail @{ run_time_limit_millis = 180000 } -Enabled $true -DiscoverOffline $true -DiscoverNew $true -Distribute $true -ExpirationInterval 10m
New-FalconItScheduledTask -TaskId <id> -Target "platform_name:'Windows'" -Schedule @{ timezone = '-0500'; start_time = '2025-05-13T22:17:00.000Z'; frequency = 'Monthly'; day_of_month = 5; time = '17:17' } -Enabled $true
2025-08-04: PSFalcon v2.2.9