crowdstrike.falcon.prevention_policy module – Manage Falcon prevention policies

Note

This module is part of the crowdstrike.falcon collection (version 4.15.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install crowdstrike.falcon. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: crowdstrike.falcon.prevention_policy.

New in crowdstrike.falcon 4.15.0

Synopsis

  • Create, update, enable, disable and delete Falcon prevention policies.

  • The same task creates the prevention policy when it is missing, updates it when it is different, and deletes it with state=absent.

  • The module finds a policy by policy_id, or by name and platform_name.

  • The module does not manage the prevention settings or the IOA rule groups of the policy.

Requirements

The below requirements are needed on the host that executes this module.

  • Host Groups [READ] API scope, only when host_groups adds host groups

  • Prevention policies [READ, WRITE] API scope

  • crowdstrike-falconpy >= 1.5.0

  • python >= 3.12

Parameters

Parameter

Comments

auth

dictionary

The registered result of the crowdstrike.falcon.auth module, or a dictionary containing the access_token and cloud keys.

If provided, the client_id, client_secret, member_cid, and cloud options are ignored.

Useful when needing to make multiple API calls to avoid rate limiting issues.

access_token

string

The OAuth2 access token to use for authentication.

cloud

string

The CrowdStrike cloud region to use.

This can differ from the module’s cloud argument due to autodiscovery.

client_id

aliases: falcon_client_id

string

The CrowdStrike API client ID to use.

See the Falcon documentation for more information about API clients.

The FALCON_CLIENT_ID environment variable can also be used.

client_secret

aliases: falcon_client_secret

string

The CrowdStrike API secret that corresponds to the client ID.

See the Falcon documentation for more information about API clients.

The FALCON_CLIENT_SECRET environment variable can also be used.

cloud

string

The CrowdStrike cloud region to use.

All clouds are automatically discovered if not specified, except for the us-gov-1 cloud.

The FALCON_CLOUD environment variable can also be used.

Choices:

  • "us-1" ← (default)

  • "us-2"

  • "us-3"

  • "us-gov-1"

  • "us-gov-2"

  • "eu-1"

description

string

The description of the prevention policy.

An empty string clears the description.

When not set, the module does not change the description.

enabled

boolean

Whether the prevention policy is enabled.

A new policy is disabled unless this is true.

When not set, the module does not change it.

Choices:

  • false

  • true

ext_headers

dictionary

Extended headers that are prepended to the default headers dictionary.

host_groups

list / elements=string

The IDs of the host groups to assign the prevention policy to.

The IDs are compared without regard to case. An ID that is in the list more than once counts once.

The module fails before any change when a host group to add does not exist.

When not set, the module does not change the host groups of the policy.

Ignored with state=absent.

member_cid

string

The CrowdStrike member CID for MSSP authentication.

See the Falcon documentation for more information about API clients.

The FALCON_MEMBER_CID environment variable can also be used.

name

string

The name of the prevention policy.

The module finds an existing policy by this exact name on the platform in platform_name, without regard to case.

The module does not change the name of an existing policy. A name that differs only in case finds the same policy.

Requires platform_name.

Mutually exclusive with policy_id.

platform_name

string

The platform of the prevention policy. The value is case-sensitive.

A name is unique only for each platform, so the module uses the platform to find the policy by name.

The platform of an existing policy cannot change.

Required with name.

Choices:

  • "Windows"

  • "Windows_Legacy"

  • "Linux"

  • "Mac"

policy_id

string

The ID of an existing prevention policy.

The ID is compared without regard to case.

With state=present, the module fails when the ID does not exist.

Mutually exclusive with name and platform_name.

purge_host_groups

boolean

If purge_host_groups=true and host_groups is set, the module removes the host groups of the policy that are not in host_groups.

If host_groups is not set, the module does not change the host groups, even if purge_host_groups=true.

With host_groups=[] and purge_host_groups=true, the module removes all the host groups of the policy.

Choices:

  • false ← (default)

  • true

state

string

The desired state of the prevention policy.

With state=absent, the module disables an enabled policy before it deletes it, because the API does not delete an enabled policy.

Choices:

  • "present" ← (default)

  • "absent"

user_agent

string

Custom User-Agent string to use for requests to the API.

The user agent string is prepended to the default user agent string (crowdstrike-ansible/<version>).

See RFC 7231 for more information.

The FALCON_USER_AGENT environment variable can also be used.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.

diff_mode

Support: full

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

platform

Platforms: all

Target OS/families that can be operated against

See Also

See also

crowdstrike.falcon.prevention_policy_info

Get information about Falcon prevention policies.

crowdstrike.falcon.host_group

Manage Falcon host groups.

crowdstrike.falcon.host_group_info

Get information about Falcon host groups.

Prevention Policy API reference

The CrowdStrike API operations that this module uses.

Examples

- name: Create an enabled Windows prevention policy
  crowdstrike.falcon.prevention_policy:
    name: "Example prevention policy"
    platform_name: Windows
    description: "Managed by Ansible"
    enabled: true

- name: Update the description of the policy
  crowdstrike.falcon.prevention_policy:
    name: "Example prevention policy"
    platform_name: Windows
    description: "Updated by Ansible"

- name: Disable the policy
  crowdstrike.falcon.prevention_policy:
    name: "Example prevention policy"
    platform_name: Windows
    enabled: false

- name: Assign the policy to two host groups
  crowdstrike.falcon.prevention_policy:
    name: "Example prevention policy"
    platform_name: Windows
    host_groups:
      - "abcdef1234567890abcdef1234567890"
      - "1234567890abcdef1234567890abcdef"

- name: Set the exact host groups of the policy and remove the others
  crowdstrike.falcon.prevention_policy:
    name: "Example prevention policy"
    platform_name: Windows
    host_groups:
      - "abcdef1234567890abcdef1234567890"
    purge_host_groups: true

- name: Delete the policy by name and platform
  crowdstrike.falcon.prevention_policy:
    name: "Example prevention policy"
    platform_name: Windows
    state: absent

- name: Delete a prevention policy by ID
  crowdstrike.falcon.prevention_policy:
    policy_id: "12345678901234567890abcdef123456"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

prevention_policy

dictionary

The prevention policy after the change, read again from the API.

In check mode, the current policy, or the wanted values when the policy does not exist.

Returned: when state=present

cid

string

The customer ID that the policy belongs to.

Returned: success

Sample: "abcdef1234567890abcdef1234567890"

created_by

string

The user who created the prevention policy.

Returned: success

Sample: "user@example.com"

created_timestamp

string

The time when the prevention policy was created.

Returned: success

Sample: "2026-01-01T00:00:00.000000000Z"

description

string

The description of the prevention policy. Can be empty.

Returned: success

Sample: "Example description"

enabled

boolean

Whether the prevention policy is enabled.

Returned: success

Sample: true

groups

list / elements=dictionary

The host groups that the policy is assigned to.

Returned: success

assignment_rule

string

The assignment rule of the host group.

Returned: success

Sample: "hostname:['example-host']"

created_by

string

The user who created the host group.

Returned: success

Sample: "user@example.com"

created_timestamp

string

The time when the host group was created.

Returned: success

Sample: "2026-01-01T00:00:00.000000000Z"

description

string

The description of the host group.

Returned: success

Sample: "Example host group description"

group_type

string

The type of the host group.

Returned: success

Sample: "static"

id

string

The ID of the host group.

Returned: success

Sample: "abcdef1234567890abcdef1234567890"

modified_by

string

The user who last changed the host group.

Returned: success

Sample: "user@example.com"

modified_timestamp

string

The time when the host group was last changed.

Returned: success

Sample: "2026-01-01T00:00:00.000000000Z"

name

string

The name of the host group.

Returned: success

Sample: "Example host group"

id

string

The ID of the prevention policy.

Returned: success

Sample: "12345678901234567890abcdef123456"

ioa_rule_groups

list / elements=dictionary

The custom IOA rule groups that are assigned to the policy.

Returned: success

comment

string

The comment of the last change to the rule group.

Returned: success

Sample: "Example comment"

committed_timestamp

string

The time when the last change to the rule group was committed.

Returned: success

Sample: "2026-01-01T00:00:00.000000000Z"

created_by

string

The user who created the rule group.

Returned: success

Sample: "user@example.com"

created_timestamp

string

The time when the rule group was created.

Returned: success

Sample: "2026-01-01T00:00:00.000000000Z"

customer_id

string

The customer ID that the rule group belongs to.

Returned: success

Sample: "abcdef1234567890abcdef1234567890"

deleted

boolean

Whether the rule group is deleted.

Returned: success

Sample: false

description

string

The description of the rule group.

Returned: success

Sample: "Example rule group description"

enabled

boolean

Whether the rule group is enabled.

Returned: success

Sample: true

id

string

The ID of the rule group.

Returned: success

Sample: "abcdef1234567890abcdef1234567890"

modified_by

string

The user who last changed the rule group.

Returned: success

Sample: "user@example.com"

modified_timestamp

string

The time when the rule group was last changed.

Returned: success

Sample: "2026-01-01T00:00:00.000000000Z"

name

string

The name of the rule group.

Returned: success

Sample: "Example rule group"

platform

string

The platform of the rule group.

Returned: success

Sample: "windows"

rule_ids

list / elements=string

The IDs of the rules in the rule group.

Returned: success

Sample: ["1", "2"]

version

integer

The version of the rule group.

Returned: success

Sample: 1

modified_by

string

The user who last changed the prevention policy.

Returned: success

Sample: "user@example.com"

modified_timestamp

string

The time when the prevention policy was last changed.

Returned: success

Sample: "2026-01-01T00:00:00.000000000Z"

name

string

The name of the prevention policy.

Returned: success

Sample: "Example prevention policy"

platform_name

string

The platform of the prevention policy.

Returned: success

Sample: "Windows"

prevention_settings

list / elements=dictionary

The prevention settings of the policy, in categories.

Returned: success

name

string

The name of the settings category.

Returned: success

Sample: "Example category"

settings

list / elements=dictionary

The settings in the category.

Returned: success

description

string

The description of the setting.

Returned: success

Sample: "Example setting description"

id

string

The ID of the setting.

Returned: success

Sample: "ExampleSetting"

name

string

The name of the setting.

Returned: success

Sample: "Example setting"

type

string

The type of the setting.

Returned: success

Sample: "toggle"

value

dictionary

The value of the setting. The keys depend on the type of the setting.

A toggle setting has enabled and most have configured. An mlslider setting has detection and most have prevention.

Returned: success

Sample: {"configured": true, "enabled": true}

Authors

  • Carlos Matos (@carlosmmatos)