Use these command-line utilities to expedite the deployment of Workspace ONE Intelligence Hub on your Linux devices. The ws1HubUtil application is located at the agent binary directory under the installation directory: /opt/vmware/ws1-hub/bin.

The ws1HubUtil installed on the Linux device includes the following options and commands:
  • Version
  • Help

Available Commands

  • Beacon
  • Enroll
  • Logs
  • Resource
  • Sample
  • Sensor
  • Service
  • Status
  • Unenroll
  • Upgrade

ws1HubUtil available command options.

Version: The Version argument shows the hub installed version.

sudo ./ws1HubUtil --version
sudo ./ws1HubUtil -v

Help: The Help argument shows the help message.

sudo ./ws1HubUtil --help
sudo ./ws1HubUtil -h
Beacon: The Beacon command notifies the hub scheduler to trigger the beacon (heartbeat) immediately. 
sudo ./ws1HubUtil beacon
Enroll: The Enroll command handles the hub native enrollment process. 
sudo ./ws1HubUtil enroll --user xyz --password xyz --group xyz --server https://<host>.com
Table 1. Supported Command-line Arguments for the ws1HubUtil Enroll Command

Command-line argument

Short Name

Value

Description

Comments

--user

-u

Enrollment user string

User credentials generated from console.

Prompts you to enter the details if the command line argument is not entered.

--password

-p

Password String

Credentials generated from console.

Prompts you to enter the details if the command line argument is not entered.

--group

-g

Organization group String

Organization groupID to which device must enroll.

Prompts you to enter the details if the command line argument is not entered.

--token

-t

Enrollment Token

Used for token based enrollment

Used if OG enrollment type is set for token. Token can also be passed as --group field.

--server

-s

Server String

**Fully qualified** Workspace ONE UEM console URL to which the device has to enroll. The URL is typically the device services URL not necessarily the console URL. For example, https://ds135.awmdm.com.

Prompts you to enter the details if the command line argument is not entered.

--proxy-server

Proxy server info

Use during enrollment if hub needs to use proxy info (optional)

Provide the proxy server info using this argument. If enrollment goes through a proxy,

--proxy-user

Proxy username

Username for the proxy (optional)

Applicable if --proxyserver is provided and if proxy requires username and password.

--proxy-password

Proxy password

Password for the proxy (optional)

Applicable if --proxyserver is provided and if proxy requires username and password.
Logs: The Logs command collects all of the Hub and Assist logs. Logs are zipped and saved to the /tmp or user-specified folder. 
sudo ./ws1HubUtil logs --collect --path "/home/test/Downloads"
Command Options Long Name Value Description Comments
--collect Collects the logs in a zip file and copies to the /tmp folder. The default path for moving the logs is /tmp. We collect the Hub and Assist logs and zip them.

File format example: ws1-hub-20060102150405.zip
--path Folder path Folder path to copy the log zip file. Overrides the default folder path to copy the zipped log file.
Logs command options
Resource: The Resource command notifies the Hub scheduler to trigger a resource sync, pulling down available profiles/apps actions and process the actions. The command will support future Linux resources. 
sudo ./ws1HubUtil resource --sync
Resource command options

Sample: The Sample command notifies the hub scheduler to trigger a sample immediately. By default, the hub collects and sends all the samples. Also, a customized sample can be triggered. The allowed sample types are - system, network, certificate, profile, or all.

The following command triggers all sample types. 
sudo ./ws1HubUtil sample
The following command triggers allowed sample types. 
sudo ./ws1HubUtil sample --type

Example: ./ws1HubUtil sample --type network.

Table 2. Supported Command-line Arguments for the Agent Utility
Command-line argument Value Description Comments
--type system | network | certificate | profile | all Notifies the scheduler to trigger sample immediately. Queues a sample job to the hub scheduler with the specified sample type.
Sample Type Samples Collected
system System | memory | device capability
network Network adapter | WLAN
certificate certificate
profile profile
all All of the sample types
Figure 1.
Sample command options
Sensor: The Sensor command notifies the Hub scheduler to trigger a Workspace ONE sensor sync immediately. The sync fetches the latest Workspace ONE sensors, runs periodic Workspace ONE sensors, and transmits the latest values from the device to the Workspace ONE UEM console. 
sudo ./ws1HubUtil sensor --sync
The Sensor command also fetches sensor values for the device. 
sudo ./ws1HubUtil sensor --get --name "sensor_name" --pretty

Using --pretty in the command is optional.

Figure 2.
Sensor command options
Command Options Long Name Value Description Comments
--sync Notifies scheduler to trigger sensor sync A sensor sync job queues the hub scheduler,fetching latest sensors, running periodic sensors, and transmitting the latest values
--get Argument to return sensor values Returns the JSON response with sensor name and value
--name

This command is optional.

 Name of the sensor being returned Along with --get calls to fetch the named sensor value
--pretty

This command is optional.

 Formats the sensor name/value Formats the JSON response of the sensor --get
Service: The Service command provides the option to either start or stop hub services running on the device. 
sudo ./ws1HubUtil service [--start] or [--stop]
Command Options Long Name Value Description Comments
--start Starts hub services
--stop Stops hub services
Figure 3.
Service command options
Status: The Status command supports viewing the current status of the endpoint related to enrollment, assigned profiles, and dependencies. 
sudo ./ws1HubUtil status --enroll --pretty
Command Options Long Name Value Description Comments
--enroll Returns the enrollment status of the device. Returns the enrollment status in JSON format. Also, returns the current group ID and enrolled user name.
--dependency Returns the install status of these apps. Hub is dependent of multiple system apps like Ruby, network-manager, and others. Returns the install status and their priority. The result is JSON based.
--profile Returns the installed profile list along with version. JSON based response with profile name and version.
--pretty

This command is optional.

 Formats the status result/value JSON response. Pretty-printing the status result.
Status command options
Unenroll: The Unenroll command sends a request to the Workspace ONE UEM console to unenroll the device. This command requires connectivity to Workspace ONE UEM to execute. If the command is successful, the Workspace ONE UEM console marks the device as unenrolled and sends a successful response back to the device. After the response, the Hub is uninstalled on the device. If not successful, then the device logs captures the failure and the device remains enrolled. 
sudo ./ws1HubUtil unenroll

If preferred, manually uninstall the the Intelligent Hub using the command line on the device. It is not necessary to run both commands because an unenroll command is sent before the uninstall.

Examples:

Debian: 
$ sudo apt remove workspaceone-intelligent-hub
RPM for Fedora: 
$ sudo zypper remove workspaceone-intelligent-hub
Tarball: 
$ sudo /opt/Workspace-ONE-Intelligent-Hub/uninstall.sh
Upgrade: The Upgrade command queues an upgrade hub check job with the hub scheduler. The job checks if a newer version of Workspace ONE Intelligent Hubis available. If a newer version is available, then the latest package is fetched and the Hub is upgraded. 
sudo ./ws1HubUtil upgrade