You can run and test a worklet from the Automox Worklet Catalog on devices and receive near real-time results on the same screen. As part of Automox FixNow™, this Run Now option is available for specific worklets and is useful for fixing an issue quickly, testing, debugging and troubleshooting purposes.
The following topics are described here:
Prerequisites:
To run commands immediately on devices using a worklet from the Automox Worklet Catalog, you must have a global administrator, zone administrator, or zone operator role where the devices are located.
Your zone is under a plan that includes Worklets.
Note:
Worklets that require variables are currently not included in this workflow.
You can run this on up to 500 devices at a time.
You do not have to create a worklet policy.
Select a Worklet to use the Run Now Workflow
-
Access the Worklet Catalog and search for the worklet you want to run. You can access the catalog from the Manage → Worklet Catalog page.
For further details about accessing and searching in the Worklet Catalog, see our documentation for details.
-
From the Worklet Details page, click Run Now. The Run Worklet Now window opens.
-
Note: To view Evaluation and Remediation Code details, select the Code Preview drop-down menu.
-
Run Now Workflow
From the Run Worklet Now window, you can define how you want to run and test the worklet.
Criteria: The devices that you want to test must be connected and ready with a compatible OS. For status information, see What the Statuses Found in the Automox Console Mean.
-
In the Run Worklet Now window, click Select Phase to choose the phase you want to test devices for. These phases correspond to the evaluation and remediation code of the worklet. See also How to Use Worklets.
Evaluation Only: Use to test if a device needs remediation. If the exit code is 0, the evaluation is seen as successful and no remediation is required.
Remediation Only: Use to execute anything you can script, for example, enforce a configuration setting or install an application.
Evaluation and Remediation: Select if you intend to test and immediately remediate. Note that executing this way might trigger the remediation code if the evaluation criteria are met.
Go to Select Devices to search for devices that you want to run the worklet on.
-
To find devices, use the Search Devices field. You can enter the same search terms as for the Devices page (OS, name, tags, group, IP address, OS version).
The Available Devices list shows devices that match the criteria for running the worklet: these devices are connected, ready, and have a compatible OS.
The Unavailable Devices list shows devices that match the OS, but are not ready (for example, if they are running other processes such as scanning or restarting) or are not connected.
Select one or more devices from the list of Available Devices and click Run Now.
Under Results, you can read information about the progress of the worklet. When the run is complete, the name of the device is listed with a status.
You can open the Status Legend for descriptions of the worklet policy run statuses.
Click the arrow next to the device name to open the details of the worklet run.
Use the clipboard to copy the output results.
Viewing the Status Legend
Use the Status Legend drop-down menu to understand what the results for each device mean:
In Progress: The device is currently being evaluated or remediated.
Remediation Successful: The remediation script has run successfully on the device.
Remediation Failed: An error occurred during the remediation. View logs below.
Remediation Not Applicable: The device was evaluated and no action is required.
Remediation Flagged: The device was evaluated and flagged for remediation.
Unresponsive: The device became busy or disconnected and has not been evaluated or remediated.
These statuses are determined based on the exit codes of the worklet scripts. Each evaluation and remediation script block returns an exit code when that script block finishes executing on the device. When the script block returns an exit code 0, that means the script block executed successfully. Any non-zero exit code means that the script was unsuccessful.
Filtering Results by Status
Along with searching results by name, tag, or group, you can use the Filter results by field to list results according to a specific status result. Select the checkbox for the statuses you want to view results for.
About Timeouts
What happens when after 5 minutes the operation times out. If the worklet does not complete on a device within 5 minutes, it continues processing. The activity log will show if the operation completed, or if the device became unavailable or busy before starting the Run Now operation.
Viewing the Activity Log
When you click the Activity Log button, the activity log page opens filtered to show the log summary for this event. All log details for this are available and match the data that you can see in the Results window or in the exported CSV file. This data can also be exported from the activity log. See examples below.
Activity Log Example
Click Activity Log in the Run Now dialog window to access the activity log summary:
Example of the full log of the run now operation:
Related Topics