Update reference docs/guides: reset automations (#28677)

Update guides to clarify current behavior and best practice. More context here: https://github.com/fleetdm/fleet/issues/28611#issuecomment-2841952742
2025-04-30 13:00:00 -05:00
parent d51c8324fb
commit e4bbe185a8
3 changed files with 6 additions and 4 deletions
@@ -30,9 +30,9 @@ SELECT 1 FROM apps WHERE bundle_identifier = 'com.adobe.Reader' AND version_comp

 ![Install software modal](../website/assets/images/articles/automatic-software-install-install-software.png)

-Upon failure of the selected policy, the selected software installation will be triggered.
+When a host fails the selected policy, this will trigger the software to be installed on the host.

-> Adding a software automation to a policy, or changing the automated software title, will reset the policy's host counts.
+If the software install fails, you can reset a software automation and trigger the install on all targeted hosts again. To do this, deselect the policy in the **Policies > Manage automations** modal, select **Save**, and then reselect the policy. This will reset the policy's host passing and failing host counts and retrigger the software automations.

 ## How does it work?

@@ -16,9 +16,9 @@ Fleet allows users to upload scripts executed on macOS, Windows, and Linux hosts
 2. **Add a policy**: Navigate to **Policies**, select the team you want the policy to run on, and click **Add policy**. Follow the instructions to set up a custom policy or use one baked into Fleet. You can also add a script automation to an existing policy.
 3. **Set the automation**: In the previous step's **Policies** list view you navigated to, click **Manage automations**, then click **Run script**. Check the box beside the policy (or policies) for which you want to run scripts, then select a script in the drop-down that appears next to the policy name. When you're done associating policies to scripts, click **Save**.

-The next time a fleetd host fails the policy you added automation for, Fleet will queue up the script you selected and run it on the host as if you had requested a script run manually.
+When a host fails the selected policy, this will trigger the script to run on the host.

-> Adding a script to a policy will reset the policy's host counts.
+If the script fails, you can reset a script automation and trigger the script to run on all targeted hosts again. To do this, deselect the policy in the **Policies > Manage automations** modal, select **Save**, and then reselect the policy. This will reset the policy's host passing and failing host counts and retrigger the script automation.

 ## How does it work?

@@ -7530,6 +7530,8 @@ Only one of `labels_include_any` or `labels_exclude_any` can be specified. If ne

 Resets [automation](https://fleetdm.com/docs/using-fleet/automations#policy-automations) status for *all* hosts failing the specified policies. On the next automation run, any failing host will be considered newly failing.

+Currently, this API endpoint only resets ticket and webhook automations.
+
 `POST /api/v1/fleet/automations/reset`

 #### Parameters