PSFalcon

2.2.1

PowerShell for the CrowdStrike Falcon OAuth2 APIs

Minimum PowerShell version

5.1

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name PSFalcon -RequiredVersion 2.2.1

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Author(s)

Brendan Kremian

Copyright

(c) CrowdStrike. All rights reserved.

Package Details

Owners

Tags

CrowdStrike Falcon OAuth2 REST API Windows Linux MacOS

Functions

Get-FalconAlert Invoke-FalconAlertAction Confirm-FalconDiscoverAwsAccess Edit-FalconDiscoverAwsAccount Get-FalconDiscoverAwsAccount Get-FalconDiscoverAwsSetting New-FalconDiscoverAwsAccount Remove-FalconDiscoverAwsAccount Update-FalconDiscoverAwsSetting Get-FalconContainerAssessment Get-FalconContainerSensor Remove-FalconRegistryCredential Request-FalconRegistryCredential Remove-FalconContainerImage Show-FalconRegistryCredential Edit-FalconHorizonAwsAccount Edit-FalconHorizonAzureAccount Edit-FalconHorizonPolicy Edit-FalconHorizonSchedule Get-FalconHorizonAwsAccount Get-FalconHorizonAwsLink Get-FalconHorizonAzureAccount Get-FalconHorizonIoa Get-FalconHorizonIoaEvent Get-FalconHorizonIoaUser Get-FalconHorizonIom Get-FalconHorizonPolicy Get-FalconHorizonSchedule New-FalconHorizonAwsAccount New-FalconHorizonAzureAccount Receive-FalconHorizonAwsScript Receive-FalconHorizonAzureScript Remove-FalconHorizonAwsAccount Remove-FalconHorizonAzureAccount Edit-FalconIoaGroup Edit-FalconIoaRule Get-FalconIoaGroup Get-FalconIoaPlatform Get-FalconIoaRule Get-FalconIoaSeverity Get-FalconIoaType New-FalconIoaGroup New-FalconIoaRule Remove-FalconIoaGroup Remove-FalconIoaRule Test-FalconIoaRule Get-FalconDiscoverAzureAccount Get-FalconDiscoverGcpAccount New-FalconDiscoverAzureAccount New-FalconDiscoverGcpAccount Receive-FalconDiscoverAzureScript Receive-FalconDiscoverGcpScript Update-FalconDiscoverAzureAccount Edit-FalconDetection Get-FalconDetection Edit-FalconDeviceControlPolicy Get-FalconDeviceControlPolicy Get-FalconDeviceControlPolicyMember Invoke-FalconDeviceControlPolicyAction New-FalconDeviceControlPolicy Remove-FalconDeviceControlPolicy Set-FalconDeviceControlPrecedence Add-FalconGroupingTag Get-FalconHost Invoke-FalconHostAction Remove-FalconGroupingTag Get-FalconAsset Get-FalconCompleteAllowlist Get-FalconCompleteBlocklist Get-FalconCompleteCollection Get-FalconCompleteDetection Get-FalconCompleteEscalation Get-FalconCompleteIncident Get-FalconCompleteRemediation Get-FalconActor Get-FalconIndicator Get-FalconIntel Receive-FalconIntel Get-FalconRule Receive-FalconRule Get-FalconReport Get-FalconSubmission Get-FalconSubmissionQuota New-FalconSubmission Receive-FalconArtifact Remove-FalconReport Get-FalconFimChange Edit-FalconFirewallGroup Edit-FalconFirewallPolicy Edit-FalconFirewallSetting Get-FalconFirewallEvent Get-FalconFirewallField Get-FalconFirewallGroup Get-FalconFirewallPlatform Get-FalconFirewallPolicy Get-FalconFirewallPolicyMember Get-FalconFirewallRule Get-FalconFirewallSetting Invoke-FalconFirewallPolicyAction New-FalconFirewallGroup New-FalconFirewallPolicy Remove-FalconFirewallGroup Remove-FalconFirewallPolicy Set-FalconFirewallPrecedence Edit-FalconHostGroup Get-FalconHostGroup Get-FalconHostGroupMember Invoke-FalconHostGroupAction New-FalconHostGroup Remove-FalconHostGroup Invoke-FalconIdentityGraph Get-FalconBehavior Get-FalconIncident Get-FalconScore Invoke-FalconIncidentAction Edit-FalconInstallToken Get-FalconInstallToken Get-FalconInstallTokenEvent Get-FalconInstallTokenSetting New-FalconInstallToken Remove-FalconInstallToken Edit-FalconIoc Get-FalconIoc New-FalconIoc Remove-FalconIoc Get-FalconIocHost Get-FalconIocProcess Edit-FalconContainerAwsAccount Get-FalconContainerAwsAccount Get-FalconContainerCloud Get-FalconContainerCluster Invoke-FalconContainerScan New-FalconContainerAwsAccount New-FalconContainerKey Receive-FalconContainerYaml Remove-FalconContainerAwsAccount Get-FalconMalQuery Get-FalconMalQueryQuota Get-FalconMalQuerySample Group-FalconMalQuerySample Invoke-FalconMalQuery Receive-FalconMalQuerySample Search-FalconMalQueryHash Add-FalconCompleteActivity Edit-FalconCompleteCase New-FalconCompleteCase Get-FalconCompleteActivity Get-FalconCompleteCase Receive-FalconCompleteAttachment Send-FalconCompleteAttachment ConvertTo-FalconMlExclusion Edit-FalconMlExclusion Get-FalconMlExclusion New-FalconMlExclusion Remove-FalconMlExclusion Add-FalconCidGroupMember Add-FalconGroupRole Add-FalconUserGroupMember Edit-FalconCidGroup Edit-FalconUserGroup Get-FalconCidGroup Get-FalconCidGroupMember Get-FalconGroupRole Get-FalconMemberCid Get-FalconUserGroup Get-FalconUserGroupMember New-FalconCidGroup New-FalconUserGroup Remove-FalconCidGroup Remove-FalconCidGroupMember Remove-FalconGroupRole Remove-FalconUserGroup Remove-FalconUserGroupMember Request-FalconToken Revoke-FalconToken Test-FalconToken Get-FalconOverWatchEvent Get-FalconOverWatchDetection Get-FalconOverWatchIncident Edit-FalconPreventionPolicy Get-FalconPreventionPolicy Get-FalconPreventionPolicyMember Invoke-FalconPreventionPolicyAction New-FalconPreventionPolicy Remove-FalconPreventionPolicy Set-FalconPreventionPrecedence Export-FalconConfig Import-FalconConfig Add-FalconSensorTag Find-FalconDuplicate Get-FalconSensorTag Remove-FalconSensorTag Uninstall-FalconSensor Register-FalconEventCollector Send-FalconEvent Show-FalconEventCollector Unregister-FalconEventCollector Export-FalconReport Send-FalconWebhook Show-FalconMap Show-FalconModule Copy-FalconDeviceControlPolicy Copy-FalconFirewallPolicy Copy-FalconPreventionPolicy Copy-FalconResponsePolicy Copy-FalconSensorUpdatePolicy Get-FalconQueue Invoke-FalconDeploy Invoke-FalconRtr Get-FalconQuarantine Invoke-FalconQuarantineAction Test-FalconQuarantineAction Get-FalconQuickScan Get-FalconQuickScanQuota New-FalconQuickScan Confirm-FalconAdminCommand Edit-FalconScript Get-FalconPutFile Get-FalconScript Invoke-FalconAdminCommand Remove-FalconPutFile Remove-FalconScript Send-FalconPutFile Send-FalconScript Confirm-FalconCommand Confirm-FalconGetFile Confirm-FalconResponderCommand Get-FalconSession Invoke-FalconBatchGet Invoke-FalconCommand Invoke-FalconResponderCommand Receive-FalconGetFile Remove-FalconCommand Remove-FalconGetFile Remove-FalconSession Start-FalconSession Update-FalconSession Edit-FalconReconAction Edit-FalconReconNotification Edit-FalconReconRule Get-FalconReconAction Get-FalconReconNotification Get-FalconReconRule Get-FalconReconRulePreview New-FalconReconAction New-FalconReconRule Remove-FalconReconAction Remove-FalconReconRule Remove-FalconReconNotification Edit-FalconResponsePolicy Get-FalconResponsePolicy Get-FalconResponsePolicyMember Invoke-FalconResponsePolicyAction New-FalconResponsePolicy Remove-FalconResponsePolicy Set-FalconResponsePrecedence Get-FalconSample Send-FalconSample Receive-FalconSample Remove-FalconSample Get-FalconScheduledReport Invoke-FalconScheduledReport Receive-FalconScheduledReport Redo-FalconScheduledReport ConvertTo-FalconIoaExclusion Edit-FalconIoaExclusion Get-FalconIoaExclusion New-FalconIoaExclusion Remove-FalconIoaExclusion Get-FalconCcid Get-FalconInstaller Receive-FalconInstaller Edit-FalconSensorUpdatePolicy Get-FalconBuild Get-FalconKernel Get-FalconSensorUpdatePolicy Get-FalconSensorUpdatePolicyMember Get-FalconUninstallToken Invoke-FalconSensorUpdatePolicyAction New-FalconSensorUpdatePolicy Remove-FalconSensorUpdatePolicy Set-FalconSensorUpdatePrecedence Edit-FalconSvExclusion Get-FalconSvExclusion New-FalconSvExclusion Remove-FalconSvExclusion Get-FalconRemediation Get-FalconVulnerability Get-FalconVulnerabilityLogic Get-FalconStream Update-FalconStream Add-FalconRole Edit-FalconUser Get-FalconRole Get-FalconUser New-FalconUser Remove-FalconRole Remove-FalconUser Get-FalconZta

PSEditions

Desktop Core

Dependencies

This module has no dependencies.

Release Notes

@
New Commands

* alerts.ps1
 Get-FalconAlert
 Invoke-FalconAlertAction

* container-upload.ps1
 Get-FalconContainerAssessment
 Remove-FalconContainerImage

* container-security.ps1
 Get-FalconContainerSensor
 Remove-FalconRegistryCredential
 Request-FalconRegistryCredential
 Show-FalconRegistryCredential

General Changes

* Enabled the use of '-WhatIf' and '-Confirm' by adding 'ShouldProcess' support across the module. This also
 required the renaming of the existing '-Confirm' parameter to '-Wait' for 'Invoke-FalconAdminCommand',
 'Invoke-FalconBatchGet', 'Invoke-FalconCommand' and 'Invoke-FalconResponderCommand'.

* Updated ApiClient.Invoke() to remove blank verbose output when 'Headers' are not specified during a request.

* Created 'Get-ContainerUrl' to convert cached Hostname value into a valid 'container-upload' URL value when using
 'container-upload' commands.

* Created 'New-ShouldMessage' function to generate the output message when '-Confirm' or '-WhatIf' is used with
 a command.

* Added 'HostUrl' parameter to 'Invoke-Falcon' to force the use of 'container-upload' base URL instead of the
 cached Falcon API hostname.

* Updated 'Test-FqlStatement' private function to allow for the use of either single or double quotation marks.

* Updated RegEx patterns when validating input to look for a more restrictive list of characters to better match
 expected values.

* Various comment-based help text updates and typo corrections.

* The online help files (accessed using 'Update-Help') for PSFalcon are no longer valid for this and future
 releases as comment-based help has been included for individual commands. Using 'Get-Help <command> -Online'
 for any PSFalcon command will link you directly to the PSFalcon Wiki which includes command examples that were
 previously provided through the online help.

* Renamed 'falcon-container.ps1' to 'container-security.ps1'. Removed 'container-upload.ps1' and moved commands
 into 'container-security.ps1'.

* Modified private 'Get-ContainerUrl' function to include a 'Registry' switch to output the Falcon container
 registry URL for related commands.

Command Changes

* Add-FalconRole, Remove-FalconRole
 Updated to use 'Get-FalconRole' to determine valid 'Id' values for auto-completion.

* Add-FalconGroupingTag, Add-FalconSensorTag, Remove-FalconGroupingTag, Remove-FalconSensorTag
 Renamed 'Tags' to 'Tag' while retaining 'Tags' as an alias.

* Edit-FalconIoc, New-FalconIoc
 Added 'android' and 'ios' as valid 'Platform' values and 'MobileAction' parameter.

* Export-FalconConfig
 Updated to include the export of 'platform_default' policies.

* Export-FalconReport
 Updated to force the creation of the same columns for every result.

* Get-FalconContainerToken
 Command has been removed and replaced with 'Request-FalconRegistryCredential' which combines requests for your
 Falcon container registry password, username (modified CID value) and authorization token, which are cached
 within the PSFalcon module, similar to 'Request-FalconToken'.

* Get-FalconFirewallRule
 Updated to output rules in order of specified 'Id' values when using the 'Id' parameter. This solves an issue
 where rules are provided in order of the 'id' property when they were retrieved using the 'family' property and
 are returned out of order (in respect to the 'family' values).

* Get-FalconHost
 Updated to use new 'POST /devices/entities/devices/v2' endpoint when requesting host details, which greatly
 improves performance when using 'Get-FalconHost -Detailed'.

* Get-FalconKernel
 Corrected maximum number for 'Limit' parameter (500).

* Get-FalconScript, Get-FalconPutFile
 Updated to use new v2 endpoints which include workflow-related schema and information.

* Get-FalconUninstallToken
 Added 'Include' parameter.

* Import-FalconConfig
 Renamed 'Force' parameter to 'AssignExisting'. Retained 'Force' as an alias.

 Added 'ModifyDefault' to modify 'platform_default' policies to match settings from import for specified values.

 Added 'ModifyExisting' to modify existing items to match settings from import for specified values. Although
 'FirewallGroup' is included, rules are not currently being modified. They will be included as part of a future
 PSFalcon update.

* Invoke-FalconBatchGet
 Added 'batch_get_cmd_req_id' to each individual host result.

* Invoke-FalconDeploy
 Added 'tgz' as a supported 'Archive' format.

 Added 'cmd' as a supported 'File' and 'Run' format using 'cmd.exe' in place of 'powershell.exe'.

 Modified 'Run' to execute a custom script that launches a secondary process when provided with a script file.
 This ensures that the process will execute and not wait for completion (similar to a regular executable when
 being used with the 'run' Real-time Response command). Standard output and error streams are redirected to
 'stdout.log' and 'stderr.log' within the temporary 'FalconDeploy' directory.

 Added 'Include' parameter.

* Invoke-FalconIncidentAction
 Added 'unassign' and 'update_assigned_to_v2' actions.

* Invoke-FalconRtr
 Updated to create Real-time Response sessions in groups of 10,000.

* New-FalconHostGroup
 Added type 'staticByID'.

* New-FalconSubmission
 Added 'macOS_10.15' for parameter 'EnvironmentId'.

* Uninstall-FalconSensor
 Added timeout value (120 seconds) to reduce the chance of no 'status' value being returned.

 Added 'Include' parameter.

Resolved Issues

* Issue #211: Added try/catch to 'Get-FalconHost' when using '-Include group_names' to suppress errors when
 hosts have no groups.

* Issue #212: Added actions to 'Invoke-FalconIncidentAction'.

* Issue #219: Indirectly fixed issue with changes that were already made to 'Invoke-FalconDeploy'.
@

FileList

Version History

Version Downloads Last updated
2.2.2 192,526 9/13/2022
2.2.1 (current version) 14,000 7/5/2022
2.2.0 12,178 4/29/2022