MacOS
View all Worklets
MacOSmacOS

macOS - Tray Notification - Reset Branding Icon

Reset the Automox Agent tray icon to default Automox branding on macOS endpoints fleet-wide

Worklet Details

What the branding icon reset Worklet does

This Automox Worklet™ restores the Automox Agent tray icon to default Automox branding on macOS endpoints. The Worklet calls the agent's own management interface – amagent notifications set_icon --reset – rather than touching the icon assets under /Library/Application Support/Automox/agent-ui.app directly. That keeps the reset path identical to the one the agent itself supports, so a future agent upgrade will not invalidate the policy.

Before the Worklet runs the reset, evaluation confirms three preconditions. The agent binary exists at /usr/local/bin/amagent. The tray application bundle is installed at /Library/Application Support/Automox/agent-ui.app or /Library/Application Support/Automox/agent-ui. The installed agent version is 2.5.0 or higher, because the notifications subcommand only ships in 2.5+. If any precondition fails, the Worklet exits 0 with an explanatory message rather than treating the endpoint as non-compliant.

Remediation runs the same version check, executes the reset, and exits 0 on success or 2 on failure. The agent's existing notification process picks up the default icon on the next refresh, so most users see the change without a logout. There is no need to restart amagent or kill the agent-ui process by hand; the agent handles the icon swap in-place.

Why restore default Automox branding

Custom tray branding drifts in ways that are hard to audit. A prior admin pushed a logo for an acquired subsidiary that has since rebranded. A pilot policy applied a development-only icon to a test ring and was never reverted. A managed service provider handed the fleet back after an engagement ended, and the support-call icon is now wrong. In each case, the visual the user sees in the menu bar no longer matches the organization that supports the endpoint, which slows down help-desk triage and adds friction to user reports.

Branding state on the agent is invisible until a screenshot lands in a support ticket. A bitmap left over from a pre-acquisition logo, a Change Branding Icon policy that ran against the wrong device group, or a manual experiment by an admin who forgot to revert it all leave the agent showing an icon that no longer maps to a current tenant. Schedule this Worklet against any Mac group that should display the stock Automox icon, and every endpoint that meets the agent and tray preconditions runs amagent notifications set_icon --reset on the next policy evaluation. The reset is idempotent, so endpoints already on the default icon end up in the same state.

How the branding icon reset works

  1. Evaluation phase: The script verifies that the tray bundle exists at /Library/Application Support/Automox/agent-ui.app (or /Library/Application Support/Automox/agent-ui), confirms /usr/local/bin/amagent is present, and runs amagent version under a 5-second timeout to obtain the installed version. A helper function performs a numeric semver comparison against 2.5.0; if the endpoint is below the floor or the version cannot be read, evaluation exits 0 and remediation is skipped. If all checks pass, evaluation exits 2 to schedule remediation.

  2. Remediation phase: Remediation repeats the agent-version check, then calls /usr/local/bin/amagent notifications set_icon --reset. On a zero exit from amagent, the Worklet prints a success message and exits 0; on a non-zero exit, it prints the failure to stderr and exits 2 so the run shows up as failed in Automox activity logs. No defaults delete commands, no plist edits, and no manual amagent restart are needed – the agent reloads the default icon on its own notification cycle.

Branding icon reset requirements

  • macOS endpoint with the Automox Agent installed at /usr/local/bin/amagent

  • Automox Agent version 2.5.0 or higher – earlier agents do not implement the notifications subcommand

  • Automox Tray application present at /Library/Application Support/Automox/agent-ui.app or /Library/Application Support/Automox/agent-ui

  • Root execution context (the Automox Agent already runs with the privileges required to invoke amagent notifications)

  • FixNow / RunNow capability if you want to push the reset on demand rather than wait for the next policy evaluation

Expected tray state after the reset

After remediation, the Automox icon in the macOS menu bar reverts to the stock Automox branding shipped with the agent. Any prior custom icon set via the companion Change Branding Icon Worklet is no longer rendered, and a fresh tray launch (or the agent's next notification refresh) shows the default. The agent-ui process keeps running; monitoring, patch evaluation, and end user notifications continue uninterrupted.

Validate visually by opening the macOS menu bar on a remediated endpoint and confirming the Automox icon. For programmatic validation across a ring, run amagent version on each endpoint to confirm the agent is at 2.5.0 or higher, then check the Automox activity log for the run – success prints "Agent tray is now successfully using the default Automox branding" and exits 0. The evaluation script does not inspect the current icon, so the reset re-runs on every policy evaluation; the operation is idempotent and harmless on endpoints already on the default. Detach the policy from a group, or move it to FixNow / RunNow, once the fleet is back on stock branding.

View in app
evalutation image
remediation image

Consider Worklets your easy button

What's a Worklet?

A Worklet is an automation script, written in Bash or PowerShell, designed for seamless execution on endpoints – at scale – within the Automox platform. Worklets deploy named-CVE mitigations within hours of disclosure, perform configuration, remediation, and install or remove applications and settings across Windows, macOS, and Linux.

do more with worklets