Skip to content

Get FalconRule

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

Get-FalconRule

SYNOPSIS

Search for Falcon X rulesets

DESCRIPTION

Requires 'Rules (Falcon X): Read'.

PARAMETERS

Name Type Min Max Pattern Allowed Pipeline PipelineByName Description
Id String[] ^\d{4,}$ Ruleset identifier
Type String snort-suricata-master
snort-suricata-update
snort-suricata-changelog
yara-master
yara-update
yara-changelog
common-event-format
netwitness
False False Ruleset type
Name String[] False False Ruleset name
Description String[] False False Ruleset description
Tag String[] False False Ruleset tag
MinCreatedDate Int32 False False Filter results to those created on or after a date
MaxCreatedDate String False False Filter results to those created on or before a date
Query String False False Perform a generic substring search across available fields
Sort String False False Property and direction to sort results
Limit Int32 1 5000 False False Maximum number of results per request
Offset Int32 False False Position to begin retrieving results
Detailed Switch False False Retrieve detailed information
All Switch False False Repeat requests until all available results are retrieved
Total Switch False False Display total result count instead of results

SYNTAX

Get-FalconRule [-Type] <String> [[-Name] <String[]>] [[-Description] <String[]>] [[-Tag] <String[]>] [[-MinCreatedDate] <Int32>] [[-MaxCreatedDate] <String>] [-Query] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [-Offset <Int32>] [-Detailed] [-All] [-Total] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-FalconRule -Id <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Generated 20220922 using PSFalcon v2.2.3

Clone this wiki locally