host_group_info

Returns detailed information for one or more host groups. Some of the details returned include group name, description, group type,

Added in version 4.10.0

Parameters

Parameter	Type	Required	Default	Description
filter	str	No		FQL (Falcon Query Language) filter expression to limit results. “Examples: C(name:‘Production*’), C(group_type:‘dynamic’), C(created_timestamp:>‘2024-01-01T00:00:00Z’).” Cannot be used together with I(host_groups).
host_groups	list	No		A list of host group IDs to get information about. If not provided, all accessible host groups will be returned (subject to filter and pagination).
include_members	bool	No	false	Whether to include detailed member information for each host group. When enabled, adds a C(members) list to each group with host details. This may significantly increase response time and size for groups with many members.
limit	int	No	100	Maximum number of host groups to return. Must be between 1 and 5000.
offset	int	No	0	Starting index for pagination. Use with I(limit) to paginate through large result sets.
sort	str	No		Property to sort results by. Prefix with C(-) for descending order. “Examples: C(name), C(-created_timestamp), C(group_type).”

Examples

- name: Get information about all host groups
  crowdstrike.falcon.host_group_info:

- name: Get information about specific host groups
  crowdstrike.falcon.host_group_info:
    host_groups:
      - "12345678901234567890abcdef123456"
      - "abcdef123456789012345678901234"

- name: Search for host groups by name pattern
  crowdstrike.falcon.host_group_info:
    filter: "name:'Production*'"
    limit: 50

- name: Get dynamic host groups created in the last 7 days
  crowdstrike.falcon.host_group_info:
    filter: "group_type:'dynamic'+created_timestamp:>'{{ (ansible_date_time.epoch | int - 604800) }}'"
    sort: "-created_timestamp"

- name: Get host group information including member details
  crowdstrike.falcon.host_group_info:
    host_groups: ["12345678901234567890abcdef123456"]
    include_members: true

- name: Paginate through all host groups
  crowdstrike.falcon.host_group_info:
    limit: 100
    offset: "{{ page * 100 }}"
  loop: "{{ range(0, total_groups // 100 + 1) | list }}"
  loop_control:
    loop_var: page

Return Values

Key	Type	Description
host_groups		-
meta		M