crowdstrike.falcon.response_policy_info module – Get information about Falcon Real Time Response 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.response_policy_info.
New in crowdstrike.falcon 4.15.0
Synopsis
Returns details of Falcon Real Time Response policies.
Gets Real Time Response policies by ID, by name, or searches for them with an FQL filter.
With no option, returns every Real Time Response policy.
The module returns every match. It reads more pages when there are more than 5000 matches.
Each policy has all its Real Time Response settings, so the result can be large. Use a Jinja filter to keep only the keys that you need.
Requirements
The below requirements are needed on the host that executes this module.
Response policies [READ] API scope
crowdstrike-falconpy >= 1.5.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
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. |
|
The OAuth2 access token to use for authentication. |
|
The CrowdStrike cloud region to use. This can differ from the module’s cloud argument due to autodiscovery. |
|
The CrowdStrike API client ID to use. See the Falcon documentation for more information about API clients. The |
|
The CrowdStrike API secret that corresponds to the client ID. See the Falcon documentation for more information about API clients. The |
|
The CrowdStrike cloud region to use. All clouds are automatically discovered if not specified, except for the The Choices:
|
|
Extended headers that are prepended to the default headers dictionary. |
|
The FQL filter to search for Real Time Response policies.
Join conditions with Mutually exclusive with policy_ids. |
|
The CrowdStrike member CID for MSSP authentication. See the Falcon documentation for more information about API clients. The |
|
The exact name of the Real Time Response policies to get, compared without regard to case. A name is unique only for each platform, so more than one policy can match. Add filter with Can be combined with filter. Mutually exclusive with policy_ids. |
|
The IDs of the Real Time Response policies to get. An empty list returns no Real Time Response policies. The module fails when an ID does not exist. Then the failed result has the policies that were found in The IDs are compared without regard to case. Mutually exclusive with name, filter and sort. |
|
The property and direction to sort the results by.
Mutually exclusive with policy_ids. Choices:
|
|
Custom User-Agent string to use for requests to the API. The user agent string is prepended to the default user agent string ( See RFC 7231 for more information. The |
Attributes
Attribute |
Support |
Description |
|---|---|---|
Support: full This action does not modify state. |
Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped. |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
|
Platforms: all |
Target OS/families that can be operated against |
See Also
See also
- crowdstrike.falcon.response_policy
Manage Falcon Real Time Response policies.
- Response Policies API reference
The CrowdStrike API operations that this module uses.
Examples
- name: Get all Real Time Response policies
crowdstrike.falcon.response_policy_info:
- name: Get Real Time Response policies by ID
crowdstrike.falcon.response_policy_info:
policy_ids:
- "12345678901234567890abcdef123456"
- name: Get the Real Time Response policies with a name
crowdstrike.falcon.response_policy_info:
name: platform_default
- name: Get the Real Time Response policy with a name for one platform
crowdstrike.falcon.response_policy_info:
name: platform_default
filter: "platform_name:'Windows'"
- name: Get the enabled Windows Real Time Response policies, sorted by name
crowdstrike.falcon.response_policy_info:
filter: "platform_name:'Windows'+enabled:'true'"
sort: name.asc
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The Real Time Response policies that match the IDs, the name or the filter. An empty list when nothing matches. Returned: success |
|
The customer ID that the policy belongs to. Returned: success Sample: |
|
The user who created the Real Time Response policy. Returned: success Sample: |
|
The time when the Real Time Response policy was created. Returned: success Sample: |
|
The description of the Real Time Response policy. Can be empty. Returned: success Sample: |
|
Whether the Real Time Response policy is enabled. Returned: success Sample: |
|
The host groups that the policy is assigned to. Returned: success |
|
The user who created the host group. Returned: success Sample: |
|
The time when the host group was created. Returned: success Sample: |
|
The description of the host group. Returned: success Sample: |
|
The type of the host group. Returned: success Sample: |
|
The ID of the host group. Returned: success Sample: |
|
The user who last changed the host group. Returned: success Sample: |
|
The time when the host group was last changed. Returned: success Sample: |
|
The name of the host group. Returned: success Sample: |
|
The ID of the Real Time Response policy. Returned: success Sample: |
|
The user who last changed the Real Time Response policy. Returned: success Sample: |
|
The time when the Real Time Response policy was last changed. Returned: success Sample: |
|
The name of the Real Time Response policy. Returned: success Sample: |
|
The platform of the Real Time Response policy. Returned: success Sample: |
|
The Real Time Response settings of the policy, in categories. Returned: success |
|
The name of the settings category. Returned: success Sample: |
|
The settings in the category. Returned: success |
|
The description of the setting. Returned: success Sample: |
|
The ID of the setting. Returned: success Sample: |
|
The name of the setting. Returned: success Sample: |
|
The type of the setting. Returned: success Sample: |
|
The value of the setting.
Returned: success Sample: |