fleet/docs/Using Fleet/Learn-how-to-use-Fleet.md

58 lines
2.7 KiB
Markdown
Raw Normal View History

# Learn how to use Fleet
- [How to add your device to Fleet](#how-to-add-your-device-to-fleet)
- [How to ask questions about your device](#how-to-ask-questions-about-your-device)
### Overview
In this guide, we'll cover the following concepts:
- How to add your device to Fleet
- How to ask questions about your device
### How to add your device to Fleet
Once you log into Fleet, you are presented with the **Home** page.
To add your device:
1. Select **Add hosts**. In Fleet, devices are referred to as "hosts."
2. Select your device's platform.
3. Select **Download** to download your Fleet osquery installer. The download may take several seconds.
4. Open the Fleet osquery installer and follow the installation steps.
> It may take several seconds for Fleet osquery to send your device's data to Fleet.
In the background, Fleet ran several checks to assess the security hygiene of your device.
> In Fleet, these checks are referred to as "policies."
### How to ask questions about your device
With Fleet, you can ask a multitude of questions to help you manage, monitor, and identify threats on your devices, but if you are just starting out, and unsure of what to ask, Fleet comes baked in with a [query library](https://fleetdm.com/queries) of common questions.
So, let's start by asking the following question about your device:
* What operating system is installed on my device and what is its version?
This question can easily be answered by running this simple query: "Get operating system information."
To run this query on your device:
1. Select **Queries** in the top navigation.
2. Select **Create new query** (or browse your organization's queries for "operating system information" in the search bar).
3. Type the query you would like to run, `SELECT * FROM os_version;`.
4. Select **Run query**, then select **All hosts** (your device may be the only host added to Fleet), and finally select **Run** to execute the query.
The query may take several seconds to complete, because Fleet has to wait for the osquery agents to respond with results. Only online hosts will respond with results to a live query.
> Fleet's query response time is inherently variable because of osquery's heartbeat response time. This helps prevent performance issues on hosts.
When the query has finished, you should see several columns in the "Results" table:
- The "name" column answers: "What operating system is installed on my device?"
- The "version" column answers: "What version of the installed operating system is on my device?"
<meta name="pageOrderInSection" value="100">
<meta name="description" value="Get started with using Fleet by learning how to enroll your device into a Fleet instance and run queries to ask questions about it.">
Reorganize Fleet documentation (#12871) Closes: #12611 Changes: - Added three new documentation sections `/docs/get-started/`, `/docs/configuration` and `/docs/rest api/` - Updated folder names: `/docs/Using-Fleet/` » `/docs/Using Fleet` and `/docs/deploying` » `/docs/deploy/` - Moved `/docs/using-fleet/process-events.md` to `/articles` and updated the meta tags to change it into a guide. - Added support for a new meta tag: `navSection`. This meta tag is used to organize pages in the sidebar navigation on fleetdm.com/docs - Moved `docs/using-fleet/application-security.md` and `docs/using-fleet/security-audits.md` to the security handbook. - Moved `docs/deploying/load-testing.md` and `docs/deploying/debugging.md` to the engineering handbook. - Moved the following files/folders: - `docs/using-fleet/configuration-files/` » `docs/configuration/configuration-files/` - `docs/deploying/configuration.md` » `docs/configuration/fleet-server-configuration.md` - `docs/using-fleet/rest-api.md` » `docs/rest-api/rest-api.md` - `docs/using-fleet/monitoring-fleet.md` » `docs/deploy/rest-api.md` - Updated filenames: - `docs/using-fleet/permissions.md` » `docs/using-fleet/manage-access.md` - `docs/using-fleet/adding-hosts.md` » `docs/using-fleet/enroll-hosts.md` - `docs/using-fleet/teams.md` » `docs/using-fleet/segment-hosts.md` - `docs/using-fleet/fleet-ctl-agent-updates.md` » `docs/using-fleet/update-agents.md` - `docs/using-fleet/chromeos.md` » `docs/using-fleet/enroll-chromebooks.md` - Updated the generated markdown in `server/fleet/gen_activity_doc.go` and `server/service/osquery_utils/gen_queries_doc.go` - Updated the navigation sidebar and mobile dropdown links on docs pages to group pages by their `navSection` meta tag. - Updated fleetdm.com/docs not to show pages in the `docs/contributing/` folder in the sidebar navigation - Added redirects for docs pages that have moved. . --------- Co-authored-by: Mike Thomas <mthomas@fleetdm.com> Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-07-27 22:40:01 +00:00
<meta name="navSection" value="hidden">