This section describes the steps to download the VMware Workspace ONE Admin Assistant and install the software.

How to Download the Admin Assistant

You can access and download the Admin Assistant tool in multiple ways as listed in the following table. This table will be kept up to date.

Location Link
Release Notes VMware Workspace ONE Admin Assistant for macOS Release Notes
Workspace ONE Console when adding a macOS formatted binary (.pkg, .dmg, .mpkg, and.app)
Resource Portal Workspace ONE Admin Assistant Tool - Resource Portal
Appcast XML URL (Auto-update URL for scripts) Auto-update Appcast XML URL for Scripts

Role-Based Access to the Admin Assistant

As a best practice, create a UEM admin role that is specifically used for the Admin Assistant CLI as described in the following procedure:

  1. Log in to the Workspace ONE UEM console and select Accounts > Administrators > Roles > Add Role.

  2. Add Name and Description based on what works for your team.

    For example: Name - "AdminAssistantCLI" and Description - "Used for role based access for Admin Assistant CLI"

  3. Navigate to Apps & Books > Name: Application and click Details.

  4. To configure, choose Application Create and Application Edit and Save.

    The new role is displayed in the Roles list.

Uploading Software to Workspace ONE UEM Using the CLI

Administrators can use the command-line tool to parse and upload the files.

  1. After you install the Intelligent Hub, in the terminal, enter adminassistantcli.

  2. Sign-in to the Admin Assistant and enter the following CLI command.

    adminassistantcli config
    
    
  3. Upload the macOS software (pkg, mkpkg, app or dmg) and .plist files. Enter the following:

    adminassistantcli upload <sub commands>
    
    

    The Application ID is returned in the terminal along with the path to App Details in the console. You can use the same path to check if the apps are uploaded.

  4. Navigate to Workspace ONE UEM > Resources > Apps and refresh the page to check if the App is uploaded.

For more information on Admin Assistant tool, see Generate Metadata Using VMware AirWatch Admin Assistant Tool in Software Distribution Management for macOS and Win32 Applications guide.

Uninstalling the Admin Assistant

To uninstall the Admin Assistant through the app:

  1. Open Admin Assistant.
  2. In the top left corner of the macOS menu bar, click Workspace ONE Admin Assistant > Uninstall.

To uninstall Admin Assistant through Terminal, enter the following:

sudo sh /Applications/Workspace\ ONE\ Admin\ Assistant.app/Contents/Resources/AdminAssistantUnInstall.sh

The uninstall procedure removes the Admin Assistant app, and information stored in the macOS keychain which includes the UEM API Admin username, UEM API Admin password, UEM API key and UEM Group ID.

Note: The previously generated application data is retained even after you have uninstalled the Admin Assistant. The directory ~/Documents/Workspace ONE Admin Assistant is not deleted.

check-circle-line exclamation-circle-line close-line
Scroll to top icon