PowerShell module for FleetDM API integration
Retrieves host information from FleetDM
Get-FleetHost [-Status <String>] [-Hostname <String>] [-PolicyId <Int32>] [-SoftwareId <Int32>]
[-OSName <String>] [-OSVersion <String>] [-IncludeSoftware] [-IncludePolicies] [-DisableFailingPolicies]
[-DeviceMapping] [-MDMId <String>] [-MDMEnrollmentStatus <String>] [-MunkiIssueId <Int32>]
[-LowDiskSpace <Int32>] [-Label <String>] [-Page <Int32>] [-PerPage <Int32>] [-OrderKey <String>]
[-OrderDirection <String>] [-After <DateTime>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-FleetHost -Id <Int32> [-IncludePolicies] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Gets one or more hosts from FleetDM with optional filtering by status, team, or hostname. Supports retrieving a specific host by ID or searching for hosts based on various criteria.
Get-FleetHost
Gets all hosts in FleetDM
Get-FleetHost -Status online
Gets all online hosts
Get-FleetHost -Id 123 -IncludeSoftware -IncludePolicies
Gets detailed information for host ID 123 including software and policies
Get-FleetHost -OSName "macOS" -Status online | Select-Object id, hostname, primary_ip
Gets all online macOS hosts and displays their ID, hostname, and IP
The specific host ID to retrieve. When specified, returns detailed information for a single host.
Type: Int32
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Filter hosts by status: online, offline, or missing
Type: String
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Search for hosts by hostname (partial match supported)
Type: String
Parameter Sets: List
Aliases: Query
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Filter hosts by policy ID
Type: Int32
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
Filter hosts by software ID
Type: Int32
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
Filter hosts by operating system name
Type: String
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Filter hosts by operating system version
Type: String
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Include software inventory in the response. This significantly increases response size.
Type: SwitchParameter
Parameter Sets: List
Aliases: PopulateSoftware
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Include policy compliance information in the response
Type: SwitchParameter
Parameter Sets: (All)
Aliases: PopulatePolicies
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Filter to only show hosts with failing policies disabled
Type: SwitchParameter
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Include device mapping information
Type: SwitchParameter
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Filter by MDM ID
Type: String
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Filter by MDM enrollment status
Type: String
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Filter by Munki issue ID
Type: Int32
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
Filter hosts with low disk space (less than specified GB)
Type: Int32
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
Filter by label name or ID
Type: String
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Page number for pagination (0-based)
Type: Int32
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
Number of results per page (default: 100)
Type: Int32
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: 100
Accept pipeline input: False
Accept wildcard characters: False
Field to sort by (hostname, created_at, updated_at)
Type: String
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: Hostname
Accept pipeline input: False
Accept wildcard characters: False
Sort direction (asc or desc)
Type: String
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: Asc
Accept pipeline input: False
Accept wildcard characters: False
Return hosts added after this date
Type: DateTime
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.