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/omnissa/ws1-hub/bin.
As of version 23.10 of the Intelligent Hub, there is a symbolic link to ws1HubUtil so the device side user no longer needs to change the directory to execute. The following command examples reflect the symbolic link.
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
Version: The Version argument shows the hub installed version.
ws1HubUtil --version
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.
ws1HubUtil enroll --user xyz --password xyz --group xyz --server https://<host>.com
| 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"
Enable verbose logging using the following command:
sudo ws1HubUtil logs --verbose --enable
| 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. |
| --upload | Upload collected logs to UEM server. | Logs can be found on Device Details > Attachments > Documents page. | |
| --type | app or custom | Type of log to be collected. | Default is app if no type is requested |
| --verbose | Verbose logging toggle | ||
| --enable | Enable verbose logging | To be used with verbose flag. | |
| --disable | Disable verbose logging | To be used with verbose flag |
Use ws1HubUtil command to upload hub logs.
sudo ws1HubUtil logs --collect --upload --type=custom
After the command processes successfully, logs can be found at Device Details> Attachments > Documents page.
We have introduced a new YML file for enrolled devices: LogUploadConfig.yml, located at /opt/omnissa/ws1-hub/config/LogUploadConfig.yml.
By default, syslog on Debian based systems and the contents of /messages on Redhat based systems are included in custom logs. Using the YML file, you can update this file to provide their own log file/folder.
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
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: sudo ws1HubUtil sample --type network.
| 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 |
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.
| 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 |
Status: The Status command supports viewing the current status of the endpoint related to enrollment, assigned profiles, and dependencies.
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. | |
| --deviceinfo | Returns the Device ID on a Linux device that has been enrolled in Workspace ONE UEM. | The result will display similar to the following:
{ "deviceid": "CB45D08DE79190131380DFBC55D03645DA9F8FDE306E6EA323BDA472A03" } | |
| --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. |
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
此頁面對您有幫助嗎?