firewall_rule_groups
This data source provides information about firewall rule groups in Falcon.
API Scopes
Section titled “API Scopes”The following API scopes are required:
- Firewall management: READ
Example Usage
Section titled “Example Usage”terraform { required_providers { crowdstrike = { source = "registry.terraform.io/crowdstrike/crowdstrike" } }}
provider "crowdstrike" {}
# Get all firewall rule groupsdata "crowdstrike_firewall_rule_groups" "all" {}
# Get firewall rule groups filtered by platformdata "crowdstrike_firewall_rule_groups" "windows" { platform = "Windows"}
# Get firewall rule groups filtered by name (supports wildcards)data "crowdstrike_firewall_rule_groups" "web_rules" { name = "Web*"}
# Get specific firewall rule groups by IDdata "crowdstrike_firewall_rule_groups" "specific" { ids = ["rule_group_id_1", "rule_group_id_2"]}
# Get enabled firewall rule groupsdata "crowdstrike_firewall_rule_groups" "enabled" { enabled = true}
# Use FQL filter for advanced queriesdata "crowdstrike_firewall_rule_groups" "fql" { filter = "platform:'windows'+enabled:true"}
output "all_rule_group_names" { value = [for rg in data.crowdstrike_firewall_rule_groups.all.rule_groups : rg.name]}
output "windows_rule_group_ids" { value = [for rg in data.crowdstrike_firewall_rule_groups.windows.rule_groups : rg.id]}Schema
Section titled “Schema”Optional
Section titled “Optional”enabled(Boolean) Filter rule groups by enabled status. Cannot be used together with ‘filter’ or ‘ids’.filter(String) FQL filter to apply to the firewall rule groups query. Cannot be used together with ‘ids’ or other filter attributes.ids(List of String) List of firewall rule group IDs to retrieve. Cannot be used together with ‘filter’ or other filter attributes.name(String) Filter rule groups by name. Supports wildcard matching with ’*’. Cannot be used together with ‘filter’ or ‘ids’.platform(String) Filter rule groups by platform (Windows, Linux, Mac). Cannot be used together with ‘filter’ or ‘ids’.
Read-Only
Section titled “Read-Only”rule_groups(Attributes List) The list of firewall rule groups (see below for nested schema)
Nested Schema for rule_groups
Section titled “Nested Schema for rule_groups”Read-Only:
created_by(String) User who created the rule groupcreated_on(String) Timestamp when the rule group was createddescription(String) The firewall rule group descriptionenabled(Boolean) Whether the rule group is enabledid(String) The firewall rule group IDmodified_by(String) User who last modified the rule groupmodified_on(String) Timestamp when the rule group was last modifiedname(String) The firewall rule group nameplatform(String) The platform (Windows, Linux, Mac)rule_count(Number) Number of rules in the rule grouprules(Attributes List) The list of firewall rules in this rule group, in precedence order (see below for nested schema)
Nested Schema for rule_groups.rules
Section titled “Nested Schema for rule_groups.rules”Read-Only:
action(String) Action to take when the rule matchesaddress_family(String) Address family for the ruledescription(String) Description of the firewall ruledirection(String) Traffic direction for the ruleenabled(Boolean) Whether the rule is enabledexecutable_path(String) Path to executable that this rule applies tofqdn(String) Fully qualified domain name for the ruleicmp_code(String) ICMP code for ICMP protocol rulesicmp_type(String) ICMP type for ICMP protocol rulesid(String) Identifier for the firewall rulelocal_address(Attributes List) Local IP addresses for the rule (see below for nested schema)local_port(Attributes List) Local ports for the rule (see below for nested schema)name(String) Name of the firewall rulenetwork_location(String) Network location restrictionprotocol(String) Protocol for the ruleremote_address(Attributes List) Remote IP addresses for the rule (see below for nested schema)remote_port(Attributes List) Remote ports for the rule (see below for nested schema)service_name(String) Windows service name that this rule applies towatch_mode(Boolean) Whether watch mode (monitoring) is enabled for this rule
Nested Schema for rule_groups.rules.local_address
Section titled “Nested Schema for rule_groups.rules.local_address”Read-Only:
address(String) IP address or*for anynetmask(Number) CIDR netmask
Nested Schema for rule_groups.rules.local_port
Section titled “Nested Schema for rule_groups.rules.local_port”Read-Only:
end(Number) End port for range, 0 for single portstart(Number) Start port
Nested Schema for rule_groups.rules.remote_address
Section titled “Nested Schema for rule_groups.rules.remote_address”Read-Only:
address(String) IP address or*for anynetmask(Number) CIDR netmask
Nested Schema for rule_groups.rules.remote_port
Section titled “Nested Schema for rule_groups.rules.remote_port”Read-Only:
end(Number) End port for range, 0 for single portstart(Number) Start port