Look up devices
Look up device
Look up device
@Host InfoInput fields:serial_number(optional) - the device serial number; only provide it when the host cannot be found by the user’s email or when multiple devices match.
hostname- the device hostname.platform- the operating system platform, for exampledarwinorwindows.osVersion- the operating system version string.fleetStatus- the current Fleet status, for exampleonlineoroffline.displayName- the device’s display name in Fleet.cpuType- the CPU model.lastSeenAt- the timestamp Fleet last observed the device.fleetHostId- the internal Fleet host ID.
- Confirm the device before running a diagnostic query
- Check whether a device is online before attempting further operations
- Retrieve the Fleet host ID used by other Fleet tools
- Verify the device platform before requesting a macOS-specific action
When a user reports a device issue, use @Host Info to retrieve their device details. If the device is offline, inform the user and create a ticket for IT. If it is online, proceed with diagnostics.
Check device health
Check device health
@Host HealthInput fields:serial_number(optional) - the device serial number; only provide it when the host cannot be found by the user’s email or when multiple devices match.
hostHealth- the full health payload returned by Fleet for the device. The structure depends on the device platform and what Fleet reports.
- Verify that disk encryption is enabled before approving a software access request
- Check MDM enrollment status during device onboarding
- Diagnose battery or uptime issues a user has reported
- Confirm OS update compliance before granting elevated access
When a user submits an access request, use @Host Health to check that their device has disk encryption enabled and MDM enrollment active. If either check fails, ask the user to resolve the issue before approving the request.
Run diagnostics
List saved queries
List saved queries
@Run Saved Query.Tool name: @List Saved QueriesInput fields:query_keywords(optional) - text to filter queries by name or description.
queries- each query’sid,name,description, andauthor.total- number of queries returned.
- Find the query ID to pass to
@Run Saved Query - Show a user which diagnostic options are available
- Confirm that a specific query exists before referencing it in a rule
When a user asks what diagnostic queries are available for their device, use @List Saved Queries to retrieve the full list and summarize the query names and descriptions.
Run saved query
Run saved query
@List Saved Queries first to find the query ID to pass.Tool name: @Run Saved QueryInput fields:query_id(required) - the ID of the saved query to run; use@List Saved Queriesto find it.serial_number(optional) - the device serial number; only provide it when the host cannot be found by the user’s email or when multiple devices match.
result- the raw query results returned by the device.hostname- the hostname of the device the query ran on.hostId- the Fleet host ID.queryId- the ID of the query that was run.
- Run a disk-space query to diagnose storage complaints
- Check running processes when a device is behaving unexpectedly
- Pull OS version data as part of a troubleshooting workflow
- Execute a security query during an incident investigation
When a user reports their device is slow, use @Host Info to confirm the device is online, use @List Saved Queries to find a relevant diagnostic query, then use @Run Saved Query to execute it. Summarize the results and suggest troubleshooting steps.
Recover admin access
Get managed account password
Get managed account password
@Get Managed Account PasswordInput fields:serial_number(optional) - the device serial number; only provide it when the host cannot be found by the user’s email or when multiple devices match.
password- the managed local administrator password.updatedAt- the timestamp when the password was last rotated in Fleet.hostname- the device hostname.fleetHostId- the Fleet host ID.
- Help a macOS user regain local administrator access when they forget their password
- Support a disk recovery scenario that requires a local admin login
- Deliver a rotated admin password during endpoint troubleshooting
When a macOS user reports they are locked out of their local administrator account, use @Host Info to confirm the device, then use @Get Managed Account Password to retrieve the current admin password and share it with the user over a secure channel. If Fleet has not verified the password, create a ticket for IT to investigate.
Setup
Install Fleet integration
Configure agent
Create rules
Test tools
Best practices
- Look up the device first. Run
@Host Infobefore@Run Saved Queryor@Get Managed Account Passwordto confirm the device and retrieve the Fleet host ID. - Discover queries before running them. Use
@List Saved Querieswith a keyword filter to find the right query ID rather than hardcoding it in a rule. - Use health checks as compliance gates. Put
@Host Healthin access-request rules to verify disk encryption and MDM enrollment before approving. - Deliver passwords over a private channel. When a rule retrieves a managed account password with
@Get Managed Account Password, have it send the result through a private Slack DM, not the ticket thread.