empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 00:45:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
main
fleet/docs/Using Fleet/Scripts.md
Katheryn Satterlee f018f68e46
Update script execution documentation (#17147) 
Removed reference to **Scripts** tab and added instructions for
accessing the **Run Script** modal from the host detail page.

# Checklist for submitter

Docs-only change

---------

Co-authored-by: Brock Walters <153771548+nonpunctual@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-03-21 13:50:18 -05:00

2.2 KiB
Raw Permalink Blame History

Scripts

In Fleet you can execute a custom script to remediate an issue on your macOS, Windows, and Linux hosts.

Shell scripts are supported on macOS and Linux. All scripts will run in the host's (root) default shell (/bin/sh). Other interpreters are not supported yet.

PowerShell scripts are supported on Windows. Other types of scripts are not supported yet.

Script execution is disabled by default. Continue reading to learn how to enable scripts.

Enable scripts

If you use Fleet's macOS MDM features, scripts are automatically enabled for macOS hosts that have MDM turned on. You're set!

If you don't use MDM features, to enable scripts, we'll deploy a fleetd agent with scripts enabled:

  1. Generate a new fleetd agent for macOS, Windows, or Linux using the fleetctl package command with the --enable-scripts flag.

  2. Deploy fleetd to your hosts. If your hosts already have fleetd installed, you can deploy the new fleetd on-top of the old installation.

Learn more about generating a fleetd agent and deploying it here.

Execute a script

You can execute a script in the Fleet UI, with Fleet API, or with the fleetctl command-line interface (CLI).

Fleet UI:

  1. In Fleet, head to the Controls > Scripts tab and upload your script.

  2. Head to the Hosts page and select the host you want to run the script on.

  3. On your target host's host details page, select the Actions dropdown and select Run Script to view the Run Script menu.

  4. In the Run Script menu, select the Actions dropdown for the script you'd like to execute and choose the Run option.

Scripts run from the Fleet UI will run the next time your host checks in with Fleet. You can view the status of the script execution as well as the output in the target host's activity feed.

Fleet API: API documentation is here

fleetctl CLI:

fleetctl run-script --script-path=/path/to/script --host=hostname