Get FalconHostGroup

Get-FalconHostGroup

SYNOPSIS

Search for host groups

DESCRIPTION

Requires 'Host groups: Read'.

PARAMETERS

Name	Type	Description	Min	Max	Allowed	Pipeline	PipelineByName
Id	String[]	Host group identifier				X	X
Filter	String	Falcon Query Language expression to limit results
Sort	String	Property and direction to sort results			created_by.asc created_by.desc created_timestamp.asc created_timestamp.desc group_type.asc group_type.desc modified_by.asc modified_by.desc modified_timestamp.asc modified_timestamp.desc name.asc name.desc
Limit	Int32	Maximum number of results per request	1	500
Include	String[]	Include additional properties			members
Offset	Int32	Position to begin retrieving results
Detailed	Switch	Retrieve detailed information
All	Switch	Repeat requests until all available results are retrieved
Total	Switch	Display total result count instead of results

SYNTAX

Get-FalconHostGroup [[-Filter] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [[-Include] <String[]>] [-Offset <Int32>] [-All] [-Total] [-WhatIf] [-Confirm] [<CommonParameters>]

Get-FalconHostGroup -Id <String[]> [[-Include] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Get-FalconHostGroup [[-Filter] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [[-Include] <String[]>] [-Offset <Int32>] -Detailed [-All] [-WhatIf] [-Confirm] [<CommonParameters>]

REFERENCE

Endpoints

GET /devices/combined/host-groups/v1
GET /devices/entities/host-groups/v1
GET /devices/queries/host-groups/v1

falconpy

queryHostGroups
getHostGroups
queryCombinedHostGroups

USAGE

Retrieving host group IDs with a filter

Get-FalconHostGroup -Filter "group_type:'static'" [-All]

Retrieving host group IDs with a limit

Get-FalconHostGroup -Limit 10

Getting details of multiple host groups by ID

Get-FalconHostGroup -Id <id>, <id>

2023-04-25: PSFalcon v2.2.5